You are here

class StateFlow_Event in State Machine 7.3

Same name and namespace in other branches
  1. 6 modules/state_flow/plugins/state_flow.inc \StateFlow_Event
  2. 7 modules/state_flow/plugins/state_flow.inc \StateFlow_Event
  3. 7.2 modules/state_flow/plugins/state_flow.inc \StateFlow_Event

@todo, should this class be renamed to StateFlow_Event?

Hierarchy

Expanded class hierarchy of StateFlow_Event

File

modules/state_flow_entity/plugins/state_flow_entity.inc, line 1020
State Flow implementation of the State Machine class.

View source
class StateFlow_Event extends StateMachine_Event {
  public function get_machine() {
    return $this->machine;
  }
  public function validate() {
    if (parent::validate()) {
      if (!empty($this->options['permissions'])) {
        foreach ($this->options['permissions'] as $permission) {
          if (!user_access($permission)) {
            return FALSE;
          }
        }
      }
      return TRUE;
    }
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
StateFlow_Event::get_machine public function
StateFlow_Event::validate public function Validate that the given event can take place. Overrides StateMachine_Event::validate
StateMachine_Event::$machine protected property
StateMachine_Event::$name public property
StateMachine_Event::$options protected property
StateMachine_Event::can_transition_from public function Evaluates if this event can be used to transition from the specified state.
StateMachine_Event::execute public function Execute the event.
StateMachine_Event::finish public function Allow the event to finish after the machine has changed state.
StateMachine_Event::get_option public function Return a specific key value from the $options array.
StateMachine_Event::get_options public function Return the $options array.
StateMachine_Event::get_target_state public function Returns the target state of this event.
StateMachine_Event::__construct public function Instantiate event.