Inheritance diagram for PersistentObject:

Public Member Functions
	PersistentObject ($type, $oid=null)

	getType ()

	setType ($type)

	getBaseType ()

	getOID ()

	getBaseOID ()

	setOID ($oid)

	getDBID ()

	setDBID ($id)

&	getMapper ()

&	getDataConverter ()

	save ()

	delete ($recursive=true)

	getState ()

	setState ($state, $recursive=true)

	setImmutable ()

	getLock ()

&	duplicate ()

	copyValues (&$object, $dataTypes=array(), $copyPkValues=true)

	copyValueIntern (&$node, $valueName, $dataType, &$targetNode, $dataTypes, $valuesToIgnore)

	clearValues ($dataTypes=array())

	clearValueIntern (&$node, $valueName, $dataType, $dataTypes)

	updateOID ()

	afterCreate ()

	beforeInsert ()

	afterInsert ()

	afterLoad ()

	beforeUpdate ()

	afterUpdate ()

	beforeDelete ()

	afterDelete ()

	hasValue ($name, $type=null)

	getValue ($name, $type=null)

	removeValue ($name, $type=null)

	getUnconvertedValue ($name, $type=null)

	getConvertedValue ($name, $type=null)

	getValueTypes ($name)

	validateValues ()

	validateValueIntern (&$node, $valueName, $dataType, &$errorMsg)

	validateValue ($name, $value, $type=null)

	validateValueAgainstRestrictions ($name, $value, $type=null)

	setValue ($name, $value, $type=null, $forceSet=false)

	getValueProperties ($name, $type=null)

	setValueProperties ($name, $properties, $type=null)

	getValueProperty ($name, $property, $type=null)

	setValueProperty ($name, $property, $value, $type=null)

	getValueNames ($type=null)

	getDataTypes ()

	getProperty ($name)

	setProperty ($name, $value)

	getPropertyNames ()

	addChangeListener (&$listener)

	removeChangeListener (&$listener)

	propagateValueChange ($name, $type, $oldValue, $newValue)

	propagatePropertyChange ($name, $oldValue, $newValue)

	propagateStateChange ($oldValue, $newValue)

	getObjectDisplayName ()

	getObjectDescription ()

	getDisplayValue ()

	getValueDisplayName ($name, $type=null)

	getValueDescription ($name, $type=null)

	toString ($verbose=false)

	isIndexInSearch ()

Public Member Functions inherited from Storable
	getClassDefinitionFiles ()

	loadFromSession ()

	saveToSession ()

Public Attributes
	$_oid = null

	$_type = ''

	$_data = array()

	$_properties = array()

	$_state = STATE_CLEAN

	$_isImmutable = false

	$_changeListeners = array()

Detailed Description

PersistentObject is the base class of all persistent objects. It implements the basic persistence methods (save(), delete()) which will be delegated to the PersistenceMapper class that contsructed the object. The PersistentObject holds the object data in an associative array of the following structure:

* datatype1---valueName1---value
*                          properties---propertyName1---value
*                                       propertyName2---value
*                                       ...
*             valueName2---value
*                          properties---propertyName1---value
*                                       ...
*             ...
* datatype2---valueName1---value
*                          properties---propertyName1---value
*                                       ...
*             ...
* ...
*
* e.g.: $this->_data[DATATYPE_ATTRIBUTE]['name']['value']                 gives the value of the attribute 'name' which is of app_data_type DATATYPE_ATTRIBUTE
*       $this->_data[DATATYPE_ATTRIBUTE]['name']['properties']['visible'] gives the value of the visibility property of the
*                                                                         attribute 'name'
*

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

Definition at line 70 of file class.PersistentObject.php.

Member Function Documentation

PersistentObject::PersistentObject	(	$type,
		$oid = `null`
	)

Constructor. The object will be bound to the appripriate PersistenceMapper automatically, if the the PersistenceFacade knows the type.

Parameters

type	The object type.
oid	The object id (, optional will be calculated if not given or not valid).

Definition at line 86 of file class.PersistentObject.php.

References PersistenceFacade\composeOID(), PersistenceFacade\isValidOID(), setOID(), setState(), STATE_CLEAN, and STATE_NEW.

Referenced by Node\Node().

Here is the call graph for this function:

PersistentObject::getType ( )

Get the type of the object.

Returns: The objects type.

Definition at line 108 of file class.PersistentObject.php.

References $_type.

Referenced by Node\getNumChildren(), Node\getNumParents(), getObjectDescription(), getObjectDisplayName(), Node\getPath(), isIndexInSearch(), and updateOID().

PersistentObject::setType ( $type )

Set the type of the object.

Parameters

type	The objects type.

Definition at line 116 of file class.PersistentObject.php.

PersistentObject::getBaseType ( )

Get the base type of the object. This might differ from the type, if the object may exist in different roles and has one of these roles currently. The default implementation ' returns the object's type.

Returns: The objects base type.

Definition at line 126 of file class.PersistentObject.php.

References $_type.

Referenced by isIndexInSearch().

PersistentObject::getOID ( )

Get the object id of the PersistentObject.

Returns: The PersistentObject's oid.

Definition at line 134 of file class.PersistentObject.php.

References $_oid.

Referenced by delete(), Node\deleteChild(), getBaseOID(), getLock(), Node\getNextSibling(), Node\getPreviousSibling(), Node\loadChildren(), Node\loadParents(), save(), Node\toString(), and Node\updateParent().

PersistentObject::getBaseOID ( )

Get the base object id of the PersistentObject (see PersistentObject::getBaseType()).

Returns: The PersistentObject's oid.

Definition at line 142 of file class.PersistentObject.php.

References PersistenceFacade\getBaseOID(), and getOID().

Here is the call graph for this function:

PersistentObject::setOID ( $oid )

Set the object id of the PersistentObject.

Parameters

oid	The PersistentObject's oid.

Definition at line 150 of file class.PersistentObject.php.

References PersistenceFacade\decomposeOID(), getMapper(), and setValue().

Referenced by AuthUser\login(), PersistentObject(), and setDBID().

Here is the call graph for this function:

PersistentObject::getDBID ( )

Get the id of the object in the persistent storage.

Note: This is NOT a application unique id

Returns: The id.

Definition at line 171 of file class.PersistentObject.php.

References PersistenceFacade\getOIDParameter().

Referenced by RoleRDBBase\addChild(), UserRDBBase\addChild(), RoleRDBBase\deleteChild(), UserRDBBase\deleteChild(), RoleRDBBase\getChildrenEx(), UserRDBBase\getChildrenEx(), UserRDBBase\getLocktableChildren(), RoleRDBBase\getNMUserRoleChildren(), UserRDBBase\getNMUserRoleChildren(), User\getUserId(), RoleRDBBase\loadChildren(), and UserRDBBase\loadChildren().

Here is the call graph for this function:

PersistentObject::setDBID ( $id )

Set the id of the object in the persistent storage.

Note: This is NOT a application unique id

Parameters

id The id.

Definition at line 181 of file class.PersistentObject.php.

References PersistenceFacade\composeOID(), and setOID().

Here is the call graph for this function:

& PersistentObject::getMapper ( )

Get the PersistenceMapper of the object.

Returns: A reference to a PersistenceMapper class

Definition at line 189 of file class.PersistentObject.php.

References PersistenceFacade\getInstance(), and PersistenceFacade\isKnownType().

Referenced by copyValues(), getDataConverter(), setOID(), setValue(), toString(), and updateOID().

Here is the call graph for this function:

& PersistentObject::getDataConverter ( )

Get the DataConverter used when loading/saving values.

Returns: A reference to the dataConverter instance

Definition at line 204 of file class.PersistentObject.php.

References getMapper().

Referenced by getConvertedValue(), and getUnconvertedValue().

Here is the call graph for this function:

PersistentObject::save ( )

Save data. This call will be delegated to the PersistenceFacade class.

Definition at line 215 of file class.PersistentObject.php.

References ACTION_MODIFY, afterInsert(), afterUpdate(), beforeInsert(), beforeUpdate(), Message\get(), PersistenceFacade\getInstance(), getOID(), getState(), SearchUtil\indexInSearch(), STATE_DIRTY, STATE_NEW, and WCMFException\throwEx().

Here is the call graph for this function:

PersistentObject::delete ( $recursive = true )

Delete data. This call will be delegated to the PersistenceFacade class.

Parameters

recursive True/False whether to physically delete it's children too [default: true]

Definition at line 250 of file class.PersistentObject.php.

References ACTION_DELETE, afterDelete(), beforeDelete(), SearchUtil\deleteFromSearch(), Message\get(), PersistenceFacade\getInstance(), getOID(), and WCMFException\throwEx().

Here is the call graph for this function:

PersistentObject::getState ( )

Get the object's state:

Returns: One of the STATE constant values:

Definition at line 275 of file class.PersistentObject.php.

References $_state.

Referenced by save().

PersistentObject::setState	(	$state,
		$recursive = `true`
	)

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

Parameters

recursive True/False [Default: True]

Note: PersistentObject ignores the recursive parameter, but subclasses may use it

Definition at line 284 of file class.PersistentObject.php.

References $_state, propagateStateChange(), STATE_DELETED, STATE_DIRTY, and STATE_NEW.

Referenced by Table\deleteRow(), Table\insertRow(), PersistentObject(), setValue(), Table\setValueProperties(), setValueProperties(), and Table\Table().

Here is the call graph for this function:

PersistentObject::setImmutable ( )

Set object immutable. Sets the editable property of each value to false. and disables save/delete methods.

Note: This operation is not reversible (reload the object to get a mutable one)

Definition at line 319 of file class.PersistentObject.php.

References getDataTypes(), getValueNames(), and setValueProperty().

Referenced by getLock().

Here is the call graph for this function:

PersistentObject::getLock ( )

Get the lock on the object.

Returns: lock The lock as provided by LockManager::getLock() or null if not locked

Note: If the object is locked it's set immutable. This is not reversible (reload the object to get a mutable one)

Definition at line 335 of file class.PersistentObject.php.

References LockManager\getInstance(), getOID(), and setImmutable().

Here is the call graph for this function:

& PersistentObject::duplicate ( )

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

Returns: A reference to copy.

Definition at line 348 of file class.PersistentObject.php.

References $_data, $_isImmutable, $_oid, $_properties, $_state, and $_type.

PersistentObject::copyValues	(	&	$object,
			$dataTypes = `array()`,
			$copyPkValues = `true`
	)

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

Parameters

object	A reference to the PersistentObject to copy the values to.
dataTypes	An array of datatypes. Only values of that datatypes will be copied. Empty array means all datatypes [default:empty array]
copyPkValues	True/False wether primary key values should be copied if their datatype is included or not [default: true]

Definition at line 369 of file class.PersistentObject.php.

References getMapper().

Here is the call graph for this function:

PersistentObject::copyValueIntern	(	&	$node,
			$valueName,
			$dataType,
		&	$targetNode,
			$dataTypes,
			$valuesToIgnore
	)

Private callback for copying values

Parameters

targetnode	The node to copy the value to
dataTypes	An array of datatypes. Only values of that datatypes will be copied.
valuesToIgnore	An associative array with the value names as keys and the types as values

See Also: NodeProcessor

Definition at line 388 of file class.PersistentObject.php.

PersistentObject::clearValues ( $dataTypes = array() )

Clear all values. Set each value to null.

Parameters

dataTypes An array of datatypes. Only values of that datatypes will be cleared. Empty array means all datatypes [default:empty array]

Definition at line 405 of file class.PersistentObject.php.

PersistentObject::clearValueIntern	(	&	$node,
			$valueName,
			$dataType,
			$dataTypes
	)

Private callback for clearing values

See Also: NodeProcessor

Definition at line 414 of file class.PersistentObject.php.

PersistentObject::updateOID ( )

Recalculate the object id

Definition at line 423 of file class.PersistentObject.php.

References PersistenceFacade\composeOID(), getMapper(), getType(), and getValue().

Referenced by setValue().

Here is the call graph for this function:

PersistentObject::afterCreate ( )

Persistence hook methods. Subclasses may override this to implement special application requirements. The default implementations do nothing. This method is called once after creation of this object. At this time it is not known in the store.

Definition at line 447 of file class.PersistentObject.php.

PersistentObject::beforeInsert ( )

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

Definition at line 451 of file class.PersistentObject.php.

Referenced by save().

PersistentObject::afterInsert ( )

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

Definition at line 455 of file class.PersistentObject.php.

Referenced by save().

PersistentObject::afterLoad ( )

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

Definition at line 459 of file class.PersistentObject.php.

PersistentObject::beforeUpdate ( )

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

Definition at line 463 of file class.PersistentObject.php.

Referenced by save().

PersistentObject::afterUpdate ( )

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

Definition at line 467 of file class.PersistentObject.php.

Referenced by save().

PersistentObject::beforeDelete ( )

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

Definition at line 471 of file class.PersistentObject.php.

Referenced by delete().

PersistentObject::afterDelete ( )

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

Definition at line 475 of file class.PersistentObject.php.

Referenced by delete().

PersistentObject::hasValue	(	$name,
		$type = `null`
	)

Values and Properties Check if the node has a given item.

Parameters

name	The name of the item to query.
type	The type of the item as defined in the subclass [optional] (if type is omitted the first item value of any type that matches will be returned)

Returns: True/False wether the item exists or not.

Definition at line 488 of file class.PersistentObject.php.

References getValueNames().

Here is the call graph for this function:

PersistentObject::getValue	(	$name,
		$type = `null`
	)

Get the value of a named item.

Parameters

name	The name of the item to query.
type	The type of the item as defined in the subclass [optional] (if type is omitted the first item value of any type that matches will be returned)

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

Definition at line 499 of file class.PersistentObject.php.

Referenced by Table\getColumn(), UserImpl\getConfig(), UserRDBBase\getConfig(), getConvertedValue(), UserImpl\getFirstname(), UserRDBBase\getFirstname(), NMUserRoleBase\getFkRoleId(), NMUserRoleBase\getFkUserId(), LocktableBase\getFkUserId(), AdodbseqBase\getId(), RoleRDBBase\getId(), LocktableBase\getId(), UserRDBBase\getId(), UserImpl\getLogin(), UserRDBBase\getLogin(), RoleImpl\getName(), RoleRDBBase\getName(), UserImpl\getName(), UserRDBBase\getName(), LocktableBase\getObjectid(), UserImpl\getPassword(), UserRDBBase\getPassword(), NMUserRoleBase\getRoleRDBOID(), Table\getRow(), LocktableBase\getSessionid(), LocktableBase\getSince(), getUnconvertedValue(), NMUserRoleBase\getUserRDBOID(), LocktableBase\getUserRDBOID(), setValue(), toString(), and updateOID().

PersistentObject::removeValue	(	$name,
		$type = `null`
	)

Remove a named item.

Parameters

name	The name of the item to remove.
type	The type of the item as defined in the subclass [optional] (if type is omitted the first item value of any type that matches will be returned)

Definition at line 526 of file class.PersistentObject.php.

PersistentObject::getUnconvertedValue	(	$name,
		$type = `null`
	)

Get the unconverted value of a named item.

Parameters

name	The name of the item to query.
type	The type of the item as defined in the subclass [optional] (if type is omitted the first item value of any type that matches will be returned)

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

Definition at line 550 of file class.PersistentObject.php.

References getDataConverter(), getValue(), and getValueProperty().

Referenced by UserRDBBase\getConfig(), UserRDBBase\getFirstname(), NMUserRoleBase\getFkRoleId(), NMUserRoleBase\getFkUserId(), LocktableBase\getFkUserId(), AdodbseqBase\getId(), RoleRDBBase\getId(), LocktableBase\getId(), UserRDBBase\getId(), UserRDBBase\getLogin(), RoleRDBBase\getName(), UserRDBBase\getName(), LocktableBase\getObjectid(), UserRDBBase\getPassword(), LocktableBase\getSessionid(), and LocktableBase\getSince().

Here is the call graph for this function:

PersistentObject::getConvertedValue	(	$name,
		$type = `null`
	)

Get the converted value of a named item.

Parameters

name	The name of the item to query.
type	The type of the item as defined in the subclass [optional] (if type is omitted the first item value of any type that matches will be returned)

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

Note: The result is normally equal to that of PersistentObject::getValue() except, when the value is unconverted

Definition at line 567 of file class.PersistentObject.php.

References getDataConverter(), getValue(), and getValueProperty().

Here is the call graph for this function:

PersistentObject::getValueTypes ( $name )

Get the type of a named item.

Parameters

name	The name of the item to query.

Returns: An array containig the types of the value (in most cases this array will have length 1).

Definition at line 581 of file class.PersistentObject.php.

PersistentObject::validateValues ( )

Validate all values

Returns: Empty string if validation succeeded, an error string else. The default implementation returns the result of PersistentObject::validateValueAgainstRestrictions().

Definition at line 596 of file class.PersistentObject.php.

PersistentObject::validateValueIntern	(	&	$node,
			$valueName,
			$dataType,
		&	$errorMsg
	)

Private callback for validating values

Parameters

errorMsg A string to append error messages to

See Also: NodeProcessor

Definition at line 608 of file class.PersistentObject.php.

PersistentObject::validateValue	(	$name,
		$value,
		$type = `null`
	)

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.

Parameters

name	The name of the item to set.
value	The value of the item.
type	The type of the item as defined in the subclass [optional] (if type is omitted the first item of any type that matches will be validated)

Returns: Empty string if validation succeeded, an error string else. The default implementation returns the result of PersistentObject::validateValueAgainstRestrictions().

Note: Subclasses will override this method to implement special application requirements.

Definition at line 626 of file class.PersistentObject.php.

References validateValueAgainstRestrictions().

Referenced by setValue().

Here is the call graph for this function:

PersistentObject::validateValueAgainstRestrictions	(	$name,
		$value,
		$type = `null`
	)

Check a value's value against the restrictions set on it. This method uses the 'restrictions_match' and 'restrictions_not_match' value properties.

Parameters

name	The name of the item to set.
value	The value of the item.
type	The type of the item as defined in the subclass [optional] (if type is omitted the first item of any type that matches will be checked)

Returns: Empty string if validation succeeded, an error string else.

Definition at line 639 of file class.PersistentObject.php.

References Message\get(), and getValueProperties().

Referenced by validateValue().

Here is the call graph for this function:

PersistentObject::setValue	(	$name,
		$value,
		$type = `null`,
		$forceSet = `false`
	)

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.
type	The type of the item as defined in the subclass [optional] (if type is omitted the first item of any type that matches will be modified)
forceSet	Set the value even if it is already set and validation would fail (used to notify listeners) [default: false]

Returns: true if operation succeeds / false else

Definition at line 676 of file class.PersistentObject.php.

References getMapper(), getValue(), propagateValueChange(), setState(), STATE_DIRTY, WCMFException\throwEx(), updateOID(), and validateValue().

Referenced by UserImpl\setConfig(), UserRDBBase\setConfig(), UserImpl\setFirstname(), UserRDBBase\setFirstname(), NMUserRoleBase\setFkRoleId(), NMUserRoleBase\setFkUserId(), LocktableBase\setFkUserId(), AdodbseqBase\setId(), RoleRDBBase\setId(), LocktableBase\setId(), UserRDBBase\setId(), UserImpl\setLogin(), UserRDBBase\setLogin(), RoleImpl\setName(), UserImpl\setName(), RoleRDBBase\setName(), UserRDBBase\setName(), LocktableBase\setObjectid(), setOID(), UserImpl\setPassword(), UserRDBBase\setPassword(), NMUserRoleBase\setRoleRDB(), LocktableBase\setSessionid(), LocktableBase\setSince(), and NMUserRoleBase\setUserRDB().

Here is the call graph for this function:

PersistentObject::getValueProperties	(	$name,
		$type = `null`
	)

Get the properties of a named item.

Parameters

name	The name of the item to query.
type	The type of the item as defined in the subclass [optional] (if type is omitted the first item value of any type that matches will be returned)

Returns: An associative array holding the properties of the item / null if it doesn't exits.

Definition at line 740 of file class.PersistentObject.php.

Referenced by getValueProperty(), setValueProperty(), toString(), and validateValueAgainstRestrictions().

PersistentObject::setValueProperties	(	$name,
		$properties,
		$type = `null`
	)

Set the properties of a named item.

Parameters

name	The name of the item to set its properties.
properties	An associative array holding the properties of the item.
type	The type of the item as defined in the subclass [optional] (if type is omitted the first item of any type that matches will be modified)

Returns: true/false whether the value was set.

Definition at line 770 of file class.PersistentObject.php.

References setState(), and STATE_DIRTY.

Referenced by setValueProperty().

Here is the call graph for this function:

PersistentObject::getValueProperty	(	$name,
		$property,
		$type = `null`
	)

Get the value of one property of a named item.

Parameters

name	The name of the item to set its properties.
property	The name of the property to set.
type	The type of the item as defined in the subclass [optional] (if type is omitted the first item of any type that matches will be modified)

Returns: The value property/null if not found.

Definition at line 808 of file class.PersistentObject.php.

References getValueProperties().

Referenced by getConvertedValue(), and getUnconvertedValue().

Here is the call graph for this function:

PersistentObject::setValueProperty	(	$name,
		$property,
		$value,
		$type = `null`
	)

Set the value of one property of a named item.

Parameters

name	The name of the item to set its properties.
property	The name of the property to set.
value	The value to set on the property.
type	The type of the item as defined in the subclass [optional] (if type is omitted the first item of any type that matches will be modified)

Returns: true/false whether the value was set.

Definition at line 825 of file class.PersistentObject.php.

References getValueProperties(), and setValueProperties().

Referenced by setImmutable().

Here is the call graph for this function:

PersistentObject::getValueNames ( $type = null )

Get the names of all items.

Parameters

type	The type of the item as defined in the subclass [optional] (if type is omitted all names will be returned)

Returns: array of all item names.

Definition at line 841 of file class.PersistentObject.php.

Referenced by Table\getNumRows(), hasValue(), setImmutable(), and toString().

PersistentObject::getDataTypes ( )

Get all datatypes.

Returns: array of all datatypes.

Definition at line 862 of file class.PersistentObject.php.

Referenced by Table\getColumns(), setImmutable(), and toString().

PersistentObject::getProperty ( $name )

Get the value of a named property in the object.

Parameters

name	The name of the property to query.

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

Definition at line 871 of file class.PersistentObject.php.

Referenced by RoleRDBBase\getChildrenEx(), UserRDBBase\getChildrenEx(), Node\getNumChildren(), Node\getNumParents(), isIndexInSearch(), Node\loadChildren(), Node\loadParents(), setProperty(), and toString().

PersistentObject::setProperty	(	$name,
		$value
	)

Set the value of a named property in the object.

Parameters

name	The name of the property to set.
value	The value of the property to set.

Definition at line 885 of file class.PersistentObject.php.

References getProperty(), and propagatePropertyChange().

Here is the call graph for this function:

PersistentObject::getPropertyNames ( )

Get the names of all properties in the object.

Returns: An array consisting the names.

Definition at line 895 of file class.PersistentObject.php.

Referenced by toString().

PersistentObject::addChangeListener ( & $listener )

ChangeListener Support Add a change listener (Must be of type ChangeListener).

Parameters

listener The ChangeListener.

Definition at line 908 of file class.PersistentObject.php.

References $_changeListeners.

PersistentObject::removeChangeListener ( & $listener )

Remove a change listener (Must be of type ChangeListener).

Parameters

listener The ChangeListener.

Definition at line 916 of file class.PersistentObject.php.

PersistentObject::propagateValueChange	(	$name,
		$type,
		$oldValue,
		$newValue
	)

Notify ChangeListeners of value changes.

Parameters

name	The name of the item that has changed.
type	The type of the item that has changed.
oldValue	The old value of the item that has changed
newValue	The new value of the item that has changed

Definition at line 931 of file class.PersistentObject.php.

Referenced by setValue().