메소드 | 설명 | |
---|---|---|
__construct ( string $name, array $config = [] ) | Create a WorkflowEvent instance. | |
afterChangeStatus ( string $start, string $end ) : string | Create name for a *after change status* event. | |
afterEnterStatus ( string $status = self::ANY_STATUS ) : string | Create name for a *after enter status* event. | |
afterEnterWorkflow ( string $workflowId = self::ANY_WORKFLOW ) : string | Create name for a *after enter workflow* event. | |
afterLeaveStatus ( string $status = self::ANY_STATUS ) : string | Create name for a *after leave status* event. | |
afterLeaveWorkflow ( string $workflowId = self::ANY_WORKFLOW ) : string | Create name for a *after leave workflow* event. | |
beforeChangeStatus ( string $start, string $end ) : string | Create name for a *before change status* event. | |
beforeEnterStatus ( string $status = self::ANY_STATUS ) : string | Create name for a *before enter status* event. | |
beforeEnterWorkflow ( string $workflowId = self::ANY_WORKFLOW ) : string | Create name for a *before enter workflow* event. | |
beforeLeaveStatus ( string $status = self::ANY_STATUS ) : string | Create name for a *before leave status* event. | |
beforeLeaveWorkflow ( string $workflowId = self::ANY_WORKFLOW ) : string | Create name for a *before leave workflow* event. | |
getEndStatus ( ) : |
Get the final status reached by the model when this event occured. | |
getErrors ( ) : string[] | Returns an array containg all error messages. | |
getStartStatus ( ) : |
Get the status the model what into before this event occured. | |
getTransition ( ) : raoul2000\workflow\Transition | Get the transition concerned by this event. | |
invalidate ( string $message = null, boolean $handled = false ) | Invalidate this event. |
메소드 | 설명 | |
---|---|---|
_checkNonEmptyString ( mixed $argName, mixed $argValue ) | Test if $argValue is empty. |
public __construct ( string $name, array $config = [] ) | ||
$name | string | name of the event. |
$config | array | configuration array that may contain following keys : 'start', 'end', 'transition' |
public static afterEnterStatus ( string $status = self::ANY_STATUS ) : string | ||
$status | string | the status name or any status if not set |
리턴 | string | name of the event |
public static afterEnterWorkflow ( string $workflowId = self::ANY_WORKFLOW ) : string | ||
$workflowId | string | the workflow id or any workflow id if not set |
리턴 | string | name of the event |
public static afterLeaveStatus ( string $status = self::ANY_STATUS ) : string | ||
$status | string | the status name or any status if not set |
리턴 | string | name of the event |
public static afterLeaveWorkflow ( string $workflowId = self::ANY_WORKFLOW ) : string | ||
$workflowId | string | the workflow id or any workflow id if not set |
리턴 | string | name of the event |
public static beforeEnterStatus ( string $status = self::ANY_STATUS ) : string | ||
$status | string | the status name or any status if not set |
리턴 | string | name of the event |
public static beforeEnterWorkflow ( string $workflowId = self::ANY_WORKFLOW ) : string | ||
$workflowId | string | the workflow id or any workflow id if not set |
리턴 | string | name of the event |
public static beforeLeaveStatus ( string $status = self::ANY_STATUS ) : string | ||
$status | string | the status name or any status if not set |
리턴 | string | name of the event |
public static beforeLeaveWorkflow ( string $workflowId = self::ANY_WORKFLOW ) : string | ||
$workflowId | string | the workflow id or any workflow id if not set |
리턴 | string | name of the event |
public getEndStatus ( ) : |
||
리턴 | the end status involved in this event |
public getErrors ( ) : string[] | ||
리턴 | string[] | the list of error messages |
public getStartStatus ( ) : |
||
리턴 | the start status involved in this event |
public getTransition ( ) : raoul2000\workflow\Transition | ||
리턴 | raoul2000\workflow\Transition | the transition involved in this event or NULL if no transition is available (e.g. EnterWorkflow, LeaveWorkflow) |
public invalidate ( string $message = null, boolean $handled = false ) | ||
$message | string | error message |
$handled | boolean | Whether the event is handled. Defaults to false. When a handler sets this to be true, the event processing will stop and ignore the rest of the uninvoked event handlers. |