• Home
• Jackalope
• Item

PHP Class Jackalope\Item

Jackalope Implementation: The item has a state machine to track in what state it currently is. All API exposed methods must call Item::checkState() before doing anything. Most important is that everything that is in state deleted can not be used anymore (will detect logic errors in client code) and that if the item needs to be refreshed from the backend, this can be postponed until the item is actually accessed again. Figure: workflow state transitions For the special case of Item state after a failed transaction, see Item::rollbackTransaction() Show file Open project: jackalope/jackalope Class Usage Examples

Protected Properties

Property	Type	Description
$available_states		The states an Item can take
$depth		Depth in the workspace graph
$factory		The jackalope object factory for this object
$isNode		Whether this item is a node (otherwise it is a property)
$keepChanges		To know whether to keep changes or not when reloading in dirty state
$name		the node or property name
$new		false if item is read from backend, true if created locally in this session
$objectManager		The object manager to get nodes and properties from
$oldPath		While this item is moved but unsaved, stores the old path for refresh.
$parentPath		Normalized and absolute path to the parent item for convenience.
$path		Normalized and absolute path to this item.
$postDirtyState		The state to take after this dirty node has been refreshed. One of the STATE_ constants
$savedState		The state of the item saved when a transaction is started
$session		The session this item belongs to
$state		The state of the item, one of the STATE_ constants
$valueConverter	PHPCR\Util\ValueConverter

Public Methods

Method	Description
accept ( PHPCR\ItemVisitorInterface $visitor )	{@inheritDoc}
beginTransaction ( )	Manage item state when transaction starts. This method is called on every cached item by the ObjectManager.
commitTransaction ( )	Clean up state after a transaction. This method is called on every cached item by the ObjectManager.
confirmSaved ( )	notify this item that it has been saved into the backend.
getAncestor ( $depth )	{@inheritDoc}
getDepth ( )	{@inheritDoc}
getName ( )	{@inheritDoc}
getParent ( )	{@inheritDoc}
getPath ( )	{@inheritDoc}
getSession ( )	{@inheritDoc}
getState ( ) : integer	Get the state of the item
isClean ( ) : boolean	Whether this item is in STATE_CLEAN (meaning its data is fully synchronized with the backend)
isDeleted ( ) : boolean	Whether this item has been deleted and can not be used anymore.
isDirty ( ) : boolean	Whether this item is in state dirty.
isModified ( )	{@inheritDoc}
isMoved ( )	{@inheritDoc}
isNew ( )	{@inheritDoc}
isNode ( )	{@inheritDoc}
isSame ( PHPCR\ItemInterface $otherItem )	{@inheritDoc}
remove ( )	{@inheritDoc}
revert ( )	{@inheritDoc}
rollbackTransaction ( )	Adjust the correct item state after a transaction rollback. This method is called on every cached item by the ObjectManager.
setClean ( )	Tell this item it is clean (i.e. it has been refreshed after a modification)
setDeleted ( )	Tell this item it has been deleted and cannot be used anymore
setDirty ( boolean $keepChanges = false, $targetState = false )	Tell this item that it is dirty and needs to be refreshed
setModified ( )	Tell this item that it has been modified.
setPath ( string $path, boolean $move = false )	Set or update the path, depth, name and parent reference

Protected Methods

Method	Description
__construct ( jackalope\FactoryInterface $factory, string $path, jackalope\Session $session, ObjectManager $objectManager, boolean $new = false )	Initialize basic information common to nodes and properties
checkState ( )	This function will modify the state of the item as well as refresh it if necessary (i.e.
findItemDefinition ( callable $definitions ) : PHPCR\NodeType\ItemDefinitionInterface	Find the matching item definition for this item.
refresh ( boolean $keepChanges )	Updates the state of the current item.

Private Methods

Method	Description
setState ( integer $state )	Change the state of the item

Method Details

Property Details