Detailed Description

PersistentObject defines the interface of all persistent objects.

It mainly requires an unique identifier for each instance (ObjectId), tracking of the persistent state, methods for setting and getting values as well as callback methods for lifecycle events.

Author: ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 24 of file PersistentObject.php.

Inheritance diagram for PersistentObject:

Public Member Functions
	initialize (array $data)

	getType ()

	getMapper ()

	getOID ()

	setOID (ObjectId $oid)

	getState ()

	setState ($state)

	delete ()

	__clone ()

	copyValues (PersistentObject $object, $copyPkValues=true)

	mergeValues (PersistentObject $object)

	clearValues ()

	afterCreate ()

	beforeInsert ()

	afterInsert ()

	afterLoad ()

	beforeUpdate ()

	afterUpdate ()

	beforeDelete ()

	afterDelete ()

	getValue ($name)

	setValue ($name, $value, $forceSet=false, $trackChange=true)

	hasValue ($name)

	removeValue ($name)

	getValueNames ($excludeTransient=false)

	validateValues (Message $message)

	validateValue ($name, $value, Message $message)

	getChangedValues ()

	getOriginalValues ()

	getIndispensableObjects ()

	getProperty ($name)

	setProperty ($name, $value)

	getPropertyNames ()

	getValueProperty ($name, $property)

	setValueProperty ($name, $property, $value)

	getValuePropertyNames ($name)

	getDisplayValue ()

	dump ()

Public Attributes
const	STATE_CLEAN = 0

const	STATE_DIRTY = 1

const	STATE_NEW = 2

const	STATE_DELETED = 3

Member Function Documentation

initialize ( array $data )

Initialize the object with a set of data.

This method does not validate, does not change the object's state and does not call any listeners. Any existing data will be overwritten. The data will also be used as base line for tracking changes.

Parameters

$data An associative array with the data to set.

Implemented in PersistentObjectProxy, and DefaultPersistentObject.

getType ( )

Get the type of the object.

Returns: The objects type.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

getMapper ( )

Get the PersistenceMapper of the object.

Returns: PersistenceMapper

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

getOID ( )

Get the object id of the PersistentObject.

Returns: ObjectId

Implemented in DefaultPersistentObject, PersistentObjectProxy, and NullNode.

setOID ( ObjectId $oid )

Set the object id of the PersistentObject.

Parameters

$oid	The PersistentObject's oid.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

getState ( )

Get the object's state:

Returns: One of the STATE constant values:

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

setState ( $state )

Set the state of the object to one of the STATE constants.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

delete ( )

Delete the object.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

__clone ( )

Get a copy of the object (ChangeListeners and Lock are not copied)

Returns: PersistentObject

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

copyValues	(	PersistentObject	$object,
			$copyPkValues = `true`
	)

Copy all non-empty values to a given instance (ChangeListeners are triggered)

Parameters

$object	PersistentObject instance to copy the values to.
$copyPkValues	Boolean whether primary key values should be copied

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

mergeValues ( PersistentObject $object )

Copy all values, that don't exist yet from a given instance (ChangeListeners are not triggered)

Parameters

$object PersistentObject instance to copy the values from.

Implemented in DefaultPersistentObject, Node, and PersistentObjectProxy.

clearValues ( )

Clear all values.

Set each value to null except for the primary key values

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

afterCreate ( )

This method is called once after creation of this object.

At this time it is not known in the store.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

beforeInsert ( )

This method is called once before inserting the newly created object into the store.

Implemented in DefaultPersistentObject, PersistentObjectProxy, and AbstractUser.

afterInsert ( )

This method is called once after inserting the newly created object into the store.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

afterLoad ( )

This method is called always after loading the object from the store.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

beforeUpdate ( )

This method is called always before updating the modified object in the store.

Implemented in DefaultPersistentObject, PersistentObjectProxy, and AbstractUser.

afterUpdate ( )

This method is called always after updating the modified object in the store.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

beforeDelete ( )

This method is called once before deleting the object from the store.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

afterDelete ( )

This method is called once after deleting the object from the store.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

getValue ( $name )

Get the value of a named item.

Parameters

$name The name of the item to query.

Returns: The value of the item / null if it doesn't exits.

Implemented in DefaultPersistentObject, PersistentObjectProxy, and Node.

setValue	(	$name,
		$value,
		$forceSet = `false`,
		$trackChange = `true`
	)

Set the value of a named item if it exists.

Parameters

$name	The name of the item to set.
$value	The value of the item.
$forceSet	Boolean whether to set the value even if it is already set and to bypass validation (used to notify listeners) (default: false)
$trackChange	Boolean whether to track the change (change state, notify listeners) or not (default: true) Only set this false, if you know, what you are doing

Returns: Boolean whether the operation succeeds or not

Implemented in DefaultPersistentObject, PersistentObjectProxy, AbstractUser, and Node.

hasValue ( $name )

Check if the node has a given item.

Parameters

$name The name of the item to query.

Returns: Boolean whether the item exists or not.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

removeValue ( $name )

Remove a named item.

Parameters

$name The name of the item to remove.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

getValueNames ( $excludeTransient = false )

Get the names of all items.

Parameters

$excludeTransient Boolean whether to exclude transient values (default: false)

Returns: An array of item names.

Implemented in DefaultPersistentObject, PersistentObjectProxy, and Node.

validateValues ( Message $message )

Validate all values by calling PersistentObject::validateValue() Throws a ValidationException in case of invalid data.

Parameters

$message The Message instance used to provide translations.

Implemented in DefaultPersistentObject, and PersistentObjectProxy.

validateValue	(		$name,
			$value,
		Message	$message
	)

Check if data may be set.

The method is also called, when setting a value. Controller may call this method before setting data and saving the object. Throws a ValidationException in case of invalid data.

Parameters

$name	The name of the item to set.
$value	The value of the item.
$message	The Message instance used to provide translations. The default implementation calls PersistentObject::validateValueAgainstValidateType().

Implemented in DefaultPersistentObject, PersistentObjectProxy, AbstractUser, and AbstractRole.

getChangedValues ( )

Get the list of changed attributes since creation, loading.