wCMF 4.0: PersistentObjectProxy Class Reference

Detailed Description

PersistentObjectProxy is proxy for an PersistentObject instance.

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

Definition at line 25 of file PersistentObjectProxy.php.

Inheritance diagram for PersistentObjectProxy:

Public Member Functions
	__construct (ObjectId $oid)

	getRealSubject ()

	__call ($name, array $arguments)

	resolve ($buildDepth=BuildDepth::SINGLE)

	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)

	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)

	getValueNames ($excludeTransient=false)

	getDisplayValue ()

	dump ()

	__toString ()

Static Public Member Functions
static	fromObject ($object)

Protected Attributes
	$_oid = null

	$_realSubject = null

Additional Inherited Members
Public Attributes inherited from PersistentObject
const	STATE_CLEAN = 0

const	STATE_DIRTY = 1

const	STATE_NEW = 2

const	STATE_DELETED = 3

Constructor & Destructor Documentation

__construct ( ObjectId $oid )

Constructor.

Parameters

$oid	The object id of the PersistentObject instance.

Definition at line 34 of file PersistentObjectProxy.php.

Member Function Documentation

static fromObject ( $object )

static

Create a PersistenceProxy instance from a PersistentObject.

This is useful if you want to prevent automatic loading of the subject if it is already loaded. Returns the argument, if already an PersistentObjectProxy instance.

Parameters

$object The PersistentObject or PersistentObjectProxy

Returns: PersistentObjectProxy

Definition at line 45 of file PersistentObjectProxy.php.

getRealSubject ( )

Get the PersistentObject instance.

Returns: PersistentObject

Definition at line 63 of file PersistentObjectProxy.php.

__call	(		$name,
		array	$arguments
	)

Delegate method call to the instance.

Definition at line 73 of file PersistentObjectProxy.php.

resolve ( $buildDepth = BuildDepth::SINGLE )

Load the PersistentObject instance.

Use this method if the subject should be loaded with a depth greater than BuildDepth::SINGLE

Parameters

$buildDepth One of the BUILDDEPTH constants or a number describing the number of generations to build (default: BuildDepth::SINGLE)

Definition at line 86 of file PersistentObjectProxy.php.

initialize ( array $data )

See also: PersistentObject::initialize()

Implements PersistentObject.

Definition at line 96 of file PersistentObjectProxy.php.

getType ( )

Get the type of the PersistentObject.

Returns: String

Implements PersistentObject.

Definition at line 104 of file PersistentObjectProxy.php.

getMapper ( )

See also: PersistentObject::getMapper()

Implements PersistentObject.

Definition at line 111 of file PersistentObjectProxy.php.

getOID ( )

Get the object id of the PersistentObject.

Returns: ObjectId

Implements PersistentObject.

Definition at line 119 of file PersistentObjectProxy.php.

setOID ( ObjectId $oid )

See also: PersistentObject::setOID()

Implements PersistentObject.

Definition at line 126 of file PersistentObjectProxy.php.

getState ( )

See also: PersistentObject::getState()

Implements PersistentObject.

Definition at line 133 of file PersistentObjectProxy.php.

setState ( $state )

See also: PersistentObject::setState()

Implements PersistentObject.

Definition at line 140 of file PersistentObjectProxy.php.

delete ( )

See also: PersistentObject::delete()

Implements PersistentObject.

Definition at line 147 of file PersistentObjectProxy.php.

__clone ( )

See also: PersistentObject::__clone()

Implements PersistentObject.

Definition at line 154 of file PersistentObjectProxy.php.

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

See also: PersistentObject::copyValues()

Implements PersistentObject.

Definition at line 161 of file PersistentObjectProxy.php.

mergeValues ( PersistentObject $object )

See also: PersistentObject::mergeValues()

Implements PersistentObject.

Definition at line 168 of file PersistentObjectProxy.php.

clearValues ( )

See also: PersistentObject::clearValues()

Implements PersistentObject.

Definition at line 175 of file PersistentObjectProxy.php.

afterCreate ( )

See also: PersistentObject::afterCreate()

Implements PersistentObject.

Definition at line 182 of file PersistentObjectProxy.php.

beforeInsert ( )

See also: PersistentObject::beforeInsert()

Implements PersistentObject.

Definition at line 189 of file PersistentObjectProxy.php.

afterInsert ( )

See also: PersistentObject::afterInsert()

Implements PersistentObject.

Definition at line 196 of file PersistentObjectProxy.php.

afterLoad ( )

See also: PersistentObject::afterLoad()

Implements PersistentObject.

Definition at line 203 of file PersistentObjectProxy.php.

beforeUpdate ( )

See also: PersistentObject::beforeUpdate()

Implements PersistentObject.

Definition at line 210 of file PersistentObjectProxy.php.

afterUpdate ( )

See also: PersistentObject::afterUpdate()

Implements PersistentObject.

Definition at line 217 of file PersistentObjectProxy.php.

beforeDelete ( )

See also: PersistentObject::beforeDelete()

Implements PersistentObject.

Definition at line 224 of file PersistentObjectProxy.php.

afterDelete ( )

See also: PersistentObject::afterDelete()

Implements PersistentObject.

Definition at line 231 of file PersistentObjectProxy.php.

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.

Implements PersistentObject.

Definition at line 240 of file PersistentObjectProxy.php.

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

See also: PersistentObject::setValue()

Implements PersistentObject.

Definition at line 256 of file PersistentObjectProxy.php.

hasValue ( $name )

See also: PersistentObject::hasValue()

Implements PersistentObject.

Definition at line 263 of file PersistentObjectProxy.php.

removeValue ( $name )

See also: PersistentObject::removeValue()

Implements PersistentObject.

Definition at line 270 of file PersistentObjectProxy.php.

validateValues ( Message $message )

See also: PersistentObject::validateValues()

Implements PersistentObject.

Definition at line 277 of file PersistentObjectProxy.php.

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

See also: PersistentObject::validateValue()

Implements PersistentObject.

Definition at line 284 of file PersistentObjectProxy.php.

getChangedValues ( )

See also: PersistentObject::getChangedValues()

Implements PersistentObject.

Definition at line 291 of file PersistentObjectProxy.php.

getOriginalValues ( )

See also: PersistentObject::getOriginalValues()

Implements PersistentObject.

Definition at line 298 of file PersistentObjectProxy.php.

getIndispensableObjects ( )

See also: PersistentObject::getIndispensableObjects()

Implements PersistentObject.

Definition at line 305 of file PersistentObjectProxy.php.

getProperty ( $name )

See also: PersistentObject::getProperty()

Implements PersistentObject.

Definition at line 312 of file PersistentObjectProxy.php.

setProperty	(		$name,
			$value
	)

See also: PersistentObject::setProperty()

Implements PersistentObject.

Definition at line 319 of file PersistentObjectProxy.php.

getPropertyNames ( )

See also: PersistentObject::getPropertyNames()

Implements PersistentObject.

Definition at line 326 of file PersistentObjectProxy.php.

getValueProperty	(		$name,
			$property
	)

See also: PersistentObject::getValueProperty()

Implements PersistentObject.

Definition at line 333 of file PersistentObjectProxy.php.

setValueProperty	(		$name,
			$property,
			$value
	)

See also: PersistentObject::setValueProperty()

Implements PersistentObject.

Definition at line 340 of file PersistentObjectProxy.php.

getValuePropertyNames ( $name )

See also: PersistentObject::getValuePropertyNames()

Implements PersistentObject.

Definition at line 347 of file PersistentObjectProxy.php.

getValueNames ( $excludeTransient = false )

See also: PersistentObject::getValueNames()

Implements PersistentObject.

Definition at line 354 of file PersistentObjectProxy.php.

getDisplayValue ( )

See also: PersistentObject::getDisplayValue()

Note: Subclasses will override this for special application requirements

Implements PersistentObject.

Definition at line 362 of file PersistentObjectProxy.php.

dump ( )

See also: PersistentObject::dump()

Implements PersistentObject.

Definition at line 369 of file PersistentObjectProxy.php.

__toString ( )

Get a string representation of the instance.

Returns: String

Definition at line 377 of file PersistentObjectProxy.php.

Member Data Documentation

$_oid = null

protected

Definition at line 27 of file PersistentObjectProxy.php.

$_realSubject = null

protected

Definition at line 28 of file PersistentObjectProxy.php.