set the description of the transition (for uml generation for example)
| public setDescription ( string $description ) | ||
| $description | string | |
/**
* @test
*/
public function shouldBeAbleToCopy()
{
$a = new State('a');
$b = new State('b');
$a_copy = new State('a');
$b_copy = new State('b');
$event = 'my-event';
$rule = 'foo-rule';
$command = 'foo-command';
$description = 'foobar';
$gc = function () {
echo "guard callable";
return true;
};
$tc = function () {
echo "transition callable";
};
$t = new Transition($a, $b, $event, $rule, $command, $gc, $tc);
$t->setDescription($description);
$copy = $t->getCopy($a_copy, $b_copy);
$this->assertNotSame($a, $a_copy);
$this->assertNotSame($b, $b_copy);
$this->assertNotSame($copy, $t);
$this->assertEquals($description, $copy->getDescription());
$this->assertEquals($rule, $copy->getRuleName());
$this->assertEquals($command, $copy->getCommandName());
$this->assertEquals($event, $copy->getEvent());
$this->assertEquals($t->getName(), $copy->getName());
$this->assertEquals($t->getGuardCallable(), $copy->getGuardCallable());
$this->assertEquals($gc, $copy->getGuardCallable());
$this->assertEquals($tc, $copy->getTransitionCallable());
}
protected function createLoader()
{
//we use the array loader
//in a non-example situation we would use a backend like a
//database for example
//@see PDO adapter and loader
//define the states
$new = new State('new', State::TYPE_INITIAL);
$green = new State('green', State::TYPE_NORMAL, State::COMMAND_NULL);
$orange = new State('orange', State::TYPE_NORMAL);
$red = new State('red', State::TYPE_NORMAL);
//create the transtions by using the states
$ng = new Transition($new, $green, 'go-green', Transition::RULE_TRUE, Transition::COMMAND_NULL);
$go = new Transition($green, $orange, 'go-orange', 'izzum\\examples\\trafficlight\\rules\\CanSwitch', 'izzum\\examples\\trafficlight\\command\\SwitchOrange');
$or = new Transition($orange, $red, 'go-red', 'izzum\\examples\\trafficlight\\rules\\CanSwitch', 'izzum\\examples\\trafficlight\\command\\SwitchRed');
$rg = new Transition($red, $green, 'go-green', 'izzum\\examples\\trafficlight\\rules\\CanSwitch', 'izzum\\examples\\trafficlight\\command\\SwitchGreen');
//set some descriptions for uml generation
$ng->setDescription("from green to orange. use the switch to orange command");
$go->setDescription("from new to green. this will start the cycle");
$or->setDescription("from orange to red. use the appropriate command");
$rg->setDescription("from red back to green.");
$new->setDescription('the init state');
$green->setDescription("go!");
$orange->setDescription("looks like a shade of green...");
$red->setDescription('stop');
$transitions[] = $ng;
$transitions[] = $go;
$transitions[] = $or;
$transitions[] = $rg;
$loader = new LoaderArray($transitions);
return $loader;
}
/**
* {@inheritDoc}
*/
public function load(StateMachine $stateMachine)
{
//decode the json in a php object structure
$decoded = yaml_parse($this->getYaml(), false);
//yaml decoding returns a php array.
$name = $stateMachine->getContext()->getMachine();
$found = false;
$data = null;
if (is_array(@$decoded['machines'])) {
foreach ($decoded['machines'] as $data) {
if ($data['name'] === $name) {
$found = true;
break;
}
}
}
if (!$found) {
//no name match found
throw new Exception(sprintf('no machine data found for "%s" in yaml. seems like a wrong configuration.', $name), Exception::BAD_LOADERDATA);
}
//accessing an array with an @ error suppresion operator ('shut the f**k up' operator),
//allows you to get properties, even if they do not exist, without notices.
//this lets us be a little lazy in mapping the array properties to the state and transition properties
$states = array();
foreach ($data['states'] as $state) {
$tmp = new State($state['name'], $state['type'], @$state['entry_command'], @$state['exit_command'], @$state['entry_callable'], @$state['exit_callable']);
$tmp->setDescription(@$state['description']);
$states[$tmp->getName()] = $tmp;
}
$transitions = array();
foreach ($data['transitions'] as $transition) {
$tmp = new Transition($states[$transition['state_from']], $states[$transition['state_to']], @$transition['event'], @$transition['rule'], @$transition['command'], @$transition['guard_callable'], @$transition['transition_callable']);
$tmp->setDescription(@$transition['description']);
$transitions[] = $tmp;
}
//delegate to loader
$loader = new LoaderArray($transitions);
return $loader->load($stateMachine);
}
/**
* gets all data for transitions.
* This method is public for testing purposes
*
* @param string $machine
* the machine name
* @return Transition[]
*/
public function getLoaderData($machine)
{
$rows = $this->getTransitions($machine);
$output = array();
// array for local caching of states
$states = array();
foreach ($rows as $row) {
$state_from = $row['state_from'];
$state_to = $row['state_to'];
// create the 'from' state
if (isset($states[$state_from])) {
$from = $states[$state_from];
} else {
$from = new State($row['state_from'], $row['state_from_type'], $row['state_from_entry_command'], $row['state_from_exit_command']);
$from->setDescription($row['state_from_description']);
}
// cache the 'from' state for the next iterations
$states[$from->getName()] = $from;
// create the 'to' state
if (isset($states[$state_to])) {
$to = $states[$state_to];
} else {
$to = new State($row['state_to'], $row['state_to_type'], $row['state_to_entry_command'], $row['state_to_exit_command']);
$to->setDescription($row['state_to_description']);
}
// cache to 'to' state for the next iterations
$states[$to->getName()] = $to;
// build the transition
$transition = new Transition($from, $to, $row['event'], $row['rule'], $row['command']);
$transition->setDescription($row['transition_description']);
$output[] = $transition;
}
return $output;
}
/**
* {@inheritDoc}
*/
public function load(StateMachine $stateMachine)
{
//load the xml in a php object structure. suppres warning with @ operator since we explicitely check the return value
$xml = @simplexml_load_string($this->getXML());
if ($xml === false) {
//could not load
throw new Exception(sprintf('could not load xml data. check the xml format'), Exception::BAD_LOADERDATA);
}
$name = $stateMachine->getContext()->getMachine();
$found = false;
$data = null;
foreach ($xml->machine as $data) {
if ((string) @$data->name === $name) {
$found = true;
break;
}
}
if (!$found) {
//no name match found
throw new Exception(sprintf('no machine data found for %s in xml. seems like a wrong configuration.', $name), Exception::BAD_LOADERDATA);
}
//accessing xml as an object with the @ error suppresion operator ('shut the f**k up' operator)
//allows you to get properties, even if they do not exist, without notices.
//this let's us be a littlebit lazy since we know some nonessential properties could not be there
$states = array();
foreach ($data->states->state as $state) {
$tmp = new State((string) $state->name, (string) $state->type, (string) @$state->entry_command, (string) @$state->exit_command, (string) @$state->entry_callable, (string) @$state->exit_callable);
$tmp->setDescription((string) @$state->description);
$states[$tmp->getName()] = $tmp;
}
$transitions = array();
foreach ($data->transitions->transition as $transition) {
$tmp = new Transition($states[(string) @$transition->state_from], $states[(string) @$transition->state_to], (string) @$transition->event, (string) @$transition->rule, (string) @$transition->command, (string) @$transition->guard_callable, (string) @$transition->transition_callable);
$tmp->setDescription((string) @$transition->description);
$transitions[] = $tmp;
}
//delegate to loader
$loader = new LoaderArray($transitions);
return $loader->load($stateMachine);
}
/**
* {@inheritDoc}
*/
public function load(StateMachine $stateMachine)
{
//decode the json in a php object structure
$decoded = json_decode($this->getJSON(), false);
if (!$decoded) {
//could not decode (make sure that fully qualified names are escaped with
//2 backslashes: \\izzum\\commands\\Null and that only double quotes are used.
throw new Exception(sprintf('could not decode json data. did you only use double quotes? check the json format against %s', 'http://jsonlint.com/'), Exception::BAD_LOADERDATA);
}
$name = $stateMachine->getContext()->getMachine();
$found = false;
if (is_array(@$decoded->machines)) {
foreach ($decoded->machines as $data) {
if ($data->name === $name) {
$found = true;
break;
}
}
}
if (!$found) {
//no name match found
throw new Exception(sprintf('no machine data found for %s in json. seems like a wrong configuration.', $name), Exception::BAD_LOADERDATA);
}
//accessing json as an object with an @ error suppresion operator ('shut the f**k up' operator),
//allows you to get properties, even if they do not exist, without notices.
//this lets us be a little lazy in mapping the json properties to the state and transition properties
$states = array();
foreach ($data->states as $state) {
$tmp = new State($state->name, $state->type, @$state->entry_command, @$state->exit_command, @$state->entry_callable, @$state->exit_callable);
$tmp->setDescription(@$state->description);
$states[$tmp->getName()] = $tmp;
}
$transitions = array();
foreach ($data->transitions as $transition) {
$tmp = new Transition($states[$transition->state_from], $states[$transition->state_to], @$transition->event, @$transition->rule, @$transition->command, @$transition->guard_callable, @$transition->transition_callable);
$tmp->setDescription(@$transition->description);
$transitions[] = $tmp;
}
//delegate to loader
$loader = new LoaderArray($transitions);
return $loader->load($stateMachine);
}
