SimpleBackend Class Reference

Description

Simple and stupid backend which must be told about everything.

Good enough if configuration is loaded by some other part of application from config files, but too dumb to scan database automatically.

References are expected to be a pair of $type and $id, where $id is integer or string.

Inheritance diagram for SimpleBackend

Public Member Functions
	addType ($type, $class, $args=array(), $description=array())
	Register new state machine of type $type named $name, which is instance of class $class. More...
	addAllTypes ($known_types)
	Load all types at once. More...
	getKnownTypes ()
	Get all known state machine types. More...
	describeType ($type)
	Describe given type without creating an instance of related state machine. More...
	inferMachineType ($aref, &$type, &$id)
	Infer type of referenced machine type. More...
	createListing ($query_filters, $filtering_flags=0)
	Creates a listing using given query filters. More...
Public Member Functions inherited from AbstractBackend
	__construct ($options, $context=null, $alias)
	Initialize backend. More...
	getAlias ()
	Get current alias. More...
	setContext ($context)
	Set context if not set yet. More...
	getContext ($resource_name=null)
	Get context object (whatever it is). More...
	inferMachineType ($aref, &$type, &$id)
	Infer type of referenced machine type. More...
	getCachedMachinesCount ()
	Get number of instantiated machines in cache. More...
	getMachine ($type)
	Get state machine of given type, create it if necessary. More...
	ref ($arg1)
	Get reference to state machine instance of given type and id. More...
	nullRef ($type)
	Get reference to non-existent state machine instance of given type. More...
	createListing ($query_filters, $filtering_flags=0)
	Creates a listing using given query filters. More...
	performSelfCheck ()
	Perform a quick self-check to detect most common errors (but not all of them). More...
	getKnownTypes ()
	Get all known state machine types. More...
	describeType ($type)
	Describe given type without creating an instance of related state machine. More...

Protected Member Functions
	createMachine ($type)
	Factory method: Prepare state machine of given type - a model shared between multiple real statemachines stored in backend. More...
Protected Member Functions inherited from AbstractBackend
	createMachine ($type)
	Factory method: Prepare state machine of given type - a model shared between multiple real statemachines stored in backend. More...

Member Function Documentation

addType	(		$type,
			$class,
			$args = array(),
			$description = array()
	)

Register new state machine of type $type named $name, which is instance of class $class.

And when creating this machine, pass $args to its constructor. Also additional meta-data can be attached using $description (will be merged with name, class and args).

addAllTypes

(

$known_types

)

Load all types at once.

Argument must be exactly the same as return value of getKnownTypes method (array of arrays). Useful for loading types from cache.

getKnownTypes

(

)

Get all known state machine types.

Returns array of strings.

describeType

(

$type

)

Describe given type without creating an instance of related state machine.

Intended as data source for user interface generators (menu, navigation, ...).

Returns machine description as propery-value pairs in array. There are few well-known property names which should be used if possible. Any unknown properties will be ignored.

array(
    // Human-friendly name of the type
    'name' => 'Foo Bar',
    // Human-friendly description (one short paragraph, plain text)
    'desc' => 'Lorem ipsum dolor sit amet, ...',
    // Name of the file containing full machine definition
    'src'  => 'example/foo.json',
    ...
)

inferMachineType	(		$aref,
		&	$type,
		&	$id
	)

Infer type of referenced machine type.

Returns true if decoding is successful, $type and $id are set to decoded values. Otherwise returns false.

Since references are global identifier, this method identifies the type of referenced machine. In simple cases it maps part of ref to type, in more complex scenarios it may ask database.

In simple applications ref consists of pair $type and $id, where $id is uniquie within given $type.

$aref is array of arguments passed to ref() or single literal if only one argument was passed.

$type is string.

$id is literal or array of literals (in case of compound key).

createMachine (   $type )

protected

Factory method: Prepare state machine of given type - a model shared between multiple real statemachines stored in backend.

Do not forget that actual machine is not reachable, you only get this interface.

This creates only implementation of the machine, not concrete instance. See AbstractMachine.

Returns descendant of AbstractMachine or null.

createListing	(		$query_filters,
			$filtering_flags = 0
	)

Creates a listing using given query filters.

Listing class is inferred from the query filters, callers should not expect any particular class to be used. This allows to replace listing classes at any time without breaking anything.

This method does not perform any query on its own, it only determines which query should be done and returns appropriate listing object.

Returns

IListing.