FlupdoCrudMachine Class Reference

Simple state machine for typical CRUD entities accessed via Flupdo. More...

Inheritance diagram for FlupdoCrudMachine:

Protected Member Functions
	initializeMachine ($config)
	Define state machine used by all instances of this type. More...
	setupDefaultMachine ($config)
	Setup basic CRUD machine. More...
	create (Reference $ref, $properties)
	Create. More...
	edit (Reference $ref, $properties)
	Edit.
	delete (Reference $ref)
	Delete.
	recalculateTree ()
	Recalculate nested-sets tree indices. More...
Protected Member Functions inherited from FlupdoMachine
	initializeMachine ($config)
	Define state machine used by all instances of this type.
	scanTableColumns ()
	Scan table in database and populate properties and pk_columns arrays. More...
	checkAccessPolicy ($access_policy_name, Reference $ref)
	Returns true if user has required access_policy. More...
	queryAddAccessPolicyCondition ($access_policy_name, $query)
	Adds conditions to enforce read access_policy to query object. More...
	queryAddFrom ($query)
	Add FROM clause.
	queryGetThisTable ($query)
	Get table name with alias. More...
	queryAddStateSelect ($query)
	Add state column into select clause of the $query. More...
	queryAddPropertiesSelect ($query)
	Add properties to select. More...
	queryAddPrimaryKeyWhere ($query, $id, $clause= 'where')
	Add primary key condition to where clause. More...
Protected Member Functions inherited from AbstractMachine
	initializeMachine ($config)
	Define state machine used by all instances of this type.
	checkAccessPolicy ($access_policy, Reference $ref)
	Returns true if user has required access_policy to invoke a transition, which requires given access_policy.
	getContext ($resource_name=null)
	Get context object (whatever it is). More...
	urlFormat ($id, $url_fmt, $properties_cache)
	Create URL using properties and given format.
	resolveMachineReference ($reference_name, $properties_cache)
	Helper function to resolve reference to another machine. More...
	onStateChanged (Reference $ref, $old_state, $transition_name, $new_state)
	Called when state is changed, when transition invocation is completed.

Protected Attributes
	$owner_relation = null
	Relation defining shich machine owns this machine.
	$owner_create_transition = null
	Transition of owner to check when creating this machine.
	$nested_sets_table_columns
	Nested-sets configuration. More...
	$nested_sets_enabled = false
	Enable nested-sets tree?
	$nested_sets_order_by = 'id'
	Order by this column.
	$time_created_table_column = null
	Set this column to NOW() on create transition.
	$time_modified_table_column = null
	Set this column to NOW() on edit transition. If MySQL is in use, it is better to use CURRENT_TIMESTAMP column feature.
Protected Attributes inherited from FlupdoMachine
	$flupdo
	Database connection.
	$sphinx
	Sphinx indexer connection.
	$auth
	Authenticator (gets user id and role)
	$table
	Name of SQL table, where machine properties are stored.
	$table_alias = null
	Alias of the $table. More...
	$pk_columns = null
	List of columns which are used as primary key.
	$json_columns = array()
	List of columns which are serialized as JSON in database.
	$composed_properties = array()
	List of properties, which are composed of multiple columns.
	$user_id_table_column = null
	Column containing entity owner.
	$user_id_auth_method = null
	Auth object method name to retrieve current user ID. More...
	$load_state_with_properties = true
	True if state should not be loaded with properties.
	$filters = null
	Filters defined in configuration.
	$default_filters = null
	Default filters for listing.
	$additional_filters_data = null
	Additional filters data definition for listing.
	$state_select = null
	Select expression for selecting machine state.
Protected Attributes inherited from AbstractMachine
	$backend
	Backend, where all machines are stored.
	$context
	Global context passed from backend.
	$machine_type
	Identification within $backend.
	$url_fmt
	URL format string where machine is located, usualy only the path part, e.g. More...
	$parent_url_fmt
	URL format string where parent of this machine is located, usualy only the path part, e.g. More...
	$post_action_url_fmt
	URL format string for redirect-after-post. More...
	$states
	Descriptions of all known states – key is state id, value is * description. More...
	$state_groups
	State groups. More...
	$actions
	Description of all known actions – key is action name. More...
	$default_access_policy = null
	Default access policy. More...
	$read_access_policy = null
	Read access policy. More...
	$listing_access_policy = null
	Listing access policy. More...
	$access_policies
	Access policies. More...
	$properties
	Description of machine properties – key is property name. More...
	$views
	Description of machine views – key is view name. More...
	$references
	Description of machine references. More...

Additional Inherited Members
Public Member Functions inherited from FlupdoMachine
	invokeTransition (Reference $ref, $transition_name, $args, &$returns, $new_id_callback=null)
	Invoke state machine transition. More...
	createListing ($filters, $filtering_flags=0)
	Create generic listing on this machine type. More...
	createQueryBuilder ()
	Create query builder.
	getState ($id)
	Get current state of state machine.
	getProperties ($id, &$state_cache=null)
	Get all properties of state machine, including it's state.
	encodeProperties ($properties)
	Encode properties to database representation. More...
	decodeProperties ($properties)
	Decode properties from database representation. More...
	describeId ()
	Reflection: Describe ID (primary key). More...
Public Member Functions inherited from AbstractMachine
	__construct (AbstractBackend $backend, $type, $config, $context)
	Constructor. More...
	getState ($id)
	Get current state of state machine. More...
	getProperties ($id, &$state_cache=null)
	Get properties of state machine, including it's state. More...
	getView ($id, $view, &$properties_cache=null, &$view_cache=null, &$persistent_view_cache=null)
	Get properties in given view. More...
	isTransitionAllowed (Reference $ref, $transition_name, $state=null)
	Returns true if transition can be invoked right now. More...
	getAvailableTransitions (Reference $ref, $state=null)
	Get list of all available actions for state machine instance identified by $id.
	invokeTransition (Reference $ref, $transition_name, $args, &$returns, $new_id_callback=null)
	Invoke state machine transition. More...
	flushCache ()
	If machine properties are cached, flush all cached data.
	getMachineType ()
	Get type of this machine.
	getBackend ()
	Get backend which owns this machine.
	ref ($id)
	Helper to create Reference to this machine. More...
	nullRef ()
	Helper to create null Reference to this machine. More...
	hotRef ($properties)
	Create pre-heated reference using properties loaded from elsewhere. More...
	describeId ()
	Reflection: Describe ID (primary key). More...
	getUrlFormat ()
	Get URL format. More...
	getParentUrlFormat ()
	Get prent URL format. More...
	getPostActionUrlFormat ()
	Get URL for redirect-after-post. More...
	getMachineImplementationMTime ()
	Get mtime of machine implementation. More...
	getAllMachineStates ($having_section=null)
	Reflection: Get all states. More...
	describeMachineState ($state, $field=null)
	Reflection: Describe given machine state. More...
	describeAllMachineStates ($having_section=null)
	Reflection: Describe all states.
	getAllMachineActions ($having_section=null)
	Reflection: Get all actions (transitions) More...
	describeMachineAction ($action, $field=null)
	Reflection: Describe given machine action (transition) More...
	describeAllMachineActions ($having_section=null)
	Reflection: Describe all actions (transitions)
	getAllMachineProperties ($having_section=null)
	Reflection: Get all properties. More...
	describeMachineProperty ($property, $field=null)
	Reflection: Describe given property. More...
	describeAllMachineProperties ($having_section=null)
	Reflection: Describe all properties. More...
	getAllMachineViews ($having_section=null)
	Reflection: Get all views. More...
	describeMachineView ($view, $field=null)
	Reflection: Describe given view. More...
	describeAllMachineViews ($having_section=null)
	Reflection: Describe all views.
	getAllMachineReferences ($having_section=null)
	Reflection: Get all references. More...
	describeMachineReference ($reference, $field=null)
	Reflection: Describe given reference. More...
	describeAllMachineReferences ($having_section=null)
	Reflection: Describe all references.
	exportDot ()
	Export state machine to Graphviz source code.
Public Attributes inherited from AbstractMachine
const	RETURNS_VALUE = null
	Return value of invoked transition is just some value.
const	RETURNS_NEW_ID = 'new_id'
	Return value of invoked transition is new ID of the state machine.

Detailed Description

Simple state machine for typical CRUD entities accessed via Flupdo.

Member Function Documentation

initializeMachine (   $config )

protected

Define state machine used by all instances of this type.

Here is the call graph for this function:

setupDefaultMachine (   $config )

protected

Setup basic CRUD machine.

Deprecated:

Here is the caller graph for this function:

create ( Reference  $ref,   $properties  )

protected

Create.

$ref may be nullRef, then auto increment is used.

Here is the call graph for this function:

recalculateTree ( )

protected

Recalculate nested-sets tree indices.

To use this feature a parent, left, right and depth columns must be specified.

Composed primary keys are not supported yet.

Three extra columns are required: tree_left, tree_right, tree_depth (ints, all nullable). This function will update them according to id and parent_id columns.

Here is the caller graph for this function:

Member Data Documentation

$nested_sets_table_columns

protected

Initial value:

= array(
                'id' => 'id',
                'parent_id' => 'parent_id',
                'left' => 'tree_left',
                'right' => 'tree_right',
                'depth' => 'tree_depth',
        )

Nested-sets configuration.