Class: State

Source Location: /org/puremvc/php/multicore/utilities/statemachine/State.php

Class Overview

Defines a State.

Variables

Methods

Class Details

[line 25]
Defines a State.

[ Top ]

Class Variables

$changed =

[line 50]

The notification to dispatch when the state has actually changed

Tags:

access:

public

Type:

string

[ Top ]

$entering =

[line 37]

The notification to dispatch when entering the state

Tags:

access:

public

Type:

string

[ Top ]

$exiting =

[line 43]

The notification to dispatch when exiting the state

Tags:

access:

public

Type:

string

[ Top ]

$name =

[line 31]

The state name

Tags:

access:

public

Type:

string

[ Top ]

$transitions = array()

[line 56]

Transition map of actions to target states

Tags:

access:

protected

Type:

array

[ Top ]

Class Methods

constructor __construct [line 67]

State __construct(
string
$name, [string
$entering = null], [string
$exiting = null], [string
$changed = null])

Constructor.

Tags:

access:

public

Parameters:

string	$name	the name of the state
string	$entering	an optional notification name to be sent when entering this state
string	$exiting	an optional notification name to be sent when exiting this state
string	$changed	an optional notification name to be sent when fully transitioned to this state

[ Top ]

method defineTrans [line 82]

void; defineTrans(
string
$action, string
$target)

Define a transition.

Tags:

access:

public

Parameters:

string	$action	the name of the StateMachine::ACTION Notification type.
string	$target	the name of the target state to transition to.

[ Top ]

method getTarget [line 105]

string getTarget(
string
$action)

Get the target state name for a given action.

Tags:

access:

public

Parameters:

string

$action

the name of the StateMachine::ACTION Notification type.

[ Top ]

method removeTrans [line 94]

void; removeTrans(
string
$action)

Remove a previously defined transition.

Tags:

access:

public

Parameters:

string

$action

the name of the StateMachine::ACTION Notification type.

[ Top ]

Documentation generated on Mon, 03 Aug 2009 05:20:49 +0000 by phpDocumentor 1.4.2