PHP Класс raoul2000\workflow\validation\WorkflowScenario

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
changeStatus ( string $start, string $end ) : string Returns the scenario name for a change status action.
enterStatus ( string $status = self::ANY_STATUS ) : string Returns the scenario name for a enter status action.
enterWorkflow ( string $workflowId = self::ANY_WORKFLOW ) : string Returns the scenario name for a enter workflow action.
leaveStatus ( string $status = self::ANY_STATUS ) : string Returns the scenario name for a leave status action.
leaveWorkflow ( string $workflowId = self::ANY_WORKFLOW ) : string Returns the scenario name for a leave workflow action.
match ( string $scenario1, string $scenario2 ) : boolean Test if 2 scenario match.

Описание методов

changeStatus() публичный статический Метод

Returns the scenario name for a change status action.
public static changeStatus ( string $start, string $end ) : string
$start string the absolute start status Id
$end string the absolute end status Id
Результат string the scenario name

enterStatus() публичный статический Метод

If no argument is passed to this method, it returns a scenario name that matched any status entrance.
public static enterStatus ( string $status = self::ANY_STATUS ) : string
$status string the aboslute id of the entered status
Результат string the scenario name

enterWorkflow() публичный статический Метод

If no argument is passed to this method, the scenario name returned matches enter in any workflow.
public static enterWorkflow ( string $workflowId = self::ANY_WORKFLOW ) : string
$workflowId string the workflow id
Результат string the scenario name

leaveStatus() публичный статический Метод

If no argument is passed to this method, it returns a scenario name that matched any status leave.
public static leaveStatus ( string $status = self::ANY_STATUS ) : string
$status string the aboslute id of the status that is left
Результат string the scenario name

leaveWorkflow() публичный статический Метод

If no argument is passed to this method, the scenario name returned matches leaving any workflow.
public static leaveWorkflow ( string $workflowId = self::ANY_WORKFLOW ) : string
$workflowId string the workflow id
Результат string the scenario name

match() публичный статический Метод

Test if 2 scenario match.
public static match ( string $scenario1, string $scenario2 ) : boolean
$scenario1 string scenario name
$scenario2 string scenario name
Результат boolean TRUE if both scenario names match, FALSE otherwise