• Главная
• Jackalope
• ObjectManager

PHP Класс Jackalope\ObjectManager

For write operations, the object manager acts as the Unit of Work handler: it keeps track which nodes are dirty and updates them with the transport interface. Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$factory	jackalope\FactoryInterface	The factory to instantiate objects
$nodesAdd	Jackalope\Transport\AddNodeOperation[]	Keys are the full paths to be added
$nodesMove	Jackalope\Transport\MoveNodeOperation[]	Keys are the source paths, values the move operations containing the target path. The objectsByPath array is updated immediately and any getItem and similar requests are rewritten for the transport layer until save() Only nodes can be moved, not properties. Note: Keep in mind that moving also affects all children of the moved node, but we only have the explicitly moved paths in this array. We check on moved parents whenever retrieving a non-cached node.
$nodesRemove	Jackalope\Transport\RemoveNodeOperation[]	Keys are the full paths to be removed. Note: Keep in mind that a delete is recursive, but we only have the explicitly deleted paths in this array. We check on deleted parents whenever retrieving a non-cached node.
$objectsByPath	array	There is no notion of order here. The order is defined by order in the Node::nodes array.
$objectsByUuid	array	Take care never to put a path in here unless there is a node for that path in objectsByPath.
$operationsLog	Jackalope\Transport\Operation[]	Add, remove and move actions need to be saved in the correct order to avoid i.e. adding something where a node has not yet been moved to.
$propertiesRemove	Jackalope\Transport\RemovePropertyOperation[]	Keys are the full paths of properties to be removed.
$session	PHPCR\SessionInterface
$transport	Jackalope\Transport\TransportInterface

Открытые методы

Метод	Описание
__construct ( jackalope\FactoryInterface $factory, Jackalope\Transport\TransportInterface $transport, PHPCR\SessionInterface $session )	Create the ObjectManager instance with associated session and transport
addNode ( string $absPath, PHPCR\NodeInterface $node )	WRITE: add a node at the specified path. Schedules an add operation for the next save() and caches the node.
addVersionLabel ( $path, $label, $moveLabel )
beginTransaction ( )	Begin new transaction associated with current session.
checkin ( string $absPath ) : PHPCR\Version\VersionInterface	Removes the cache of the predecessor version after the node has been checked in.
checkout ( $absPath )	Removes the cache of the predecessor version after the node has been checked in.
clear ( )	Clears the state of the current session
cloneFromImmediately ( string $srcWorkspace, string $srcAbsPath, string $destAbsPath, boolean $removeExisting )	Implement the workspace clone method. It is dispatched immediately.
commitTransaction ( )	Complete the transaction associated with the current session.
copyNodeImmediately ( string $srcAbsPath, string $destAbsPath, string $srcWorkspace )	Implement the workspace copy method. It is dispatched immediately.
filterChildNodeNamesByType ( PHPCR\NodeInterface $node, string | array $nameFilter, string | array $typeFilter ) : ArrayIterato\ArrayIterator	This method will either let the transport filter if that is possible or forward to getNodes and return the names of the nodes found there.,
getBinaryStream ( string $path ) : resource	Retrieves the stream for a binary value.
getCachedDescendants ( string $absPath, string $class = 'Node' ) : ArrayIterato\ArrayIterator	Return an ArrayIterator containing all the cached children of the given node.
getCachedNode ( string $absPath, $class = 'Node' ) : PHPCR\NodeInterface	Get a node if it is already in cache or null otherwise.
getCachedNodeByUuid ( $uuid, string $class = 'Node' ) : PHPCR\NodeInterface	Get a node if it is already in cache or null otherwise.
getNode ( string $relPath, string $context, string $class = 'Node' ) : PHPCR\NodeInterface	Get the node identified by a relative path.
getNodeByIdentifier ( string $identifier, string $class = 'Node' ) : PHPCR\NodeInterface	Get the node identified by an uuid.
getNodeByPath ( string $absPath, string $class = 'Node', object $object = null ) : PHPCR\NodeInterface	Get the node identified by an absolute path.
getNodeType ( string $nodeType ) : DOMDocument	Get a single nodetype.
getNodeTypes ( array $nodeTypes = [] ) : array | DOMDocument	Returns the node types specified by name in the array or all types if no filter is given.
getNodesByIdentifier ( array $identifiers, string $class = 'Node' ) : ArrayIterato\ArrayIterator | Node[]	Get the nodes identified by the given UUIDs.
getNodesByPath ( array $absPaths, string $class = 'Node', array | null $typeFilter = null ) : Node[]	Get multiple nodes identified by an absolute paths. Missing nodes are ignored.
getNodesByPathAsArray ( $paths, $class = 'Node', $typeFilter = null )
getPermissions ( string $absPath ) : array	Return the permissions of the current session on the node given by path.
getPropertiesByPath ( $absPaths ) : ArrayIterato\ArrayIterator	Get all nodes of those properties in one batch, then collect the properties of them.
getPropertyByPath ( string $absPath ) : PHPCR\PropertyInterface	Get the property identified by an absolute path.
getReferences ( string $path, string $name = null ) : ArrayIterato\ArrayIterator	Returns all accessible REFERENCE properties in the workspace that point to the node
getTransport ( ) : Jackalope\Transport\TransportInterface	Implementation specific: Transport is used elsewhere, provide it here for Session
getWeakReferences ( string $path, string $name = null ) : ArrayIterato\ArrayIterator	Returns all accessible WEAKREFERENCE properties in the workspace that point to the node
hasPendingChanges ( ) : boolean	Determine if any object is modified and not saved to storage.
isNodeDeleted ( string $absPath ) : boolean	Check whether the node at path has an unpersisted delete operation and there is no other node moved or added there.
isNodeMoved ( string $absPath ) : boolean	Check whether a node path has an unpersisted move operation.
moveNode ( string $srcAbsPath, string $destAbsPath )	WRITE: move node from source path to destination path
moveNodeImmediately ( string $srcAbsPath, string $destAbsPath )	Implement the workspace move method. It is dispatched to transport immediately.
purgeDisappearedNode ( string $absPath, boolean $keepChanges ) : boolean	Purge an item given by path from the cache and return whether the node should forget it or keep it.
refresh ( boolean $keepChanges )	Refresh cached items from the backend.
registerNodeTypes ( array $types, boolean $allowUpdate ) : boolean	Register node types with the backend.
registerNodeTypesCnd ( string $cnd, boolean $allowUpdate ) : boolean | Iterator	Register node types with compact node definition format
removeItem ( string $absPath, PHPCR\PropertyInterface $property = null )	Remove a node or a property.
removeItemImmediately ( string $absPath )	Implement the workspace removeItem method.
removeVersion ( string $versionPath, string $versionName )	Remove a version given the path to the version node and the version name.
removeVersionLabel ( $path, $label )
restore ( boolean $removeExisting, string $versionPath, string $nodePath )	Restore the node at $nodePath to the version at $versionPath
rollbackTransaction ( )	Roll back the transaction associated with the current session.
save ( )	Push all recorded changes to the backend.

Защищенные методы

Метод	Описание
cascadeDelete ( string $absPath, boolean $sessionOperation = true )	Notify all cached children that they are deleted as well and clean up internal state
cascadeDeleteVersion ( string $absPath )	Notify all cached version children that they are deleted as well and clean up internal state
executeBatch ( integer $type, Jackalope\Transport\Operation[] $operations )	Execute a batch of operations of one type.
executeOperations ( array $operations )	Execute the recorded operations in the right order, skipping stale data.
getFetchPath ( string $absPath, string $class ) : string	Resolve the path through all pending operations and sanity check while doing this.
getNodePath ( string $absPath ) : array	Get the node path for a property, and the property name
notifyItems ( string $method )	Notifies the given node and all of its children and properties that a transaction has begun, was committed or rolled back so that the item has a chance to save or restore his internal state.
pathArrayToPropertiesIterator ( array $propertyPaths ) : ArrayIterato\ArrayIterator	Transform an array containing properties paths to an ArrayIterator over Property objects
performNodeRemove ( string $absPath, PHPCR\NodeInterface $node, boolean $sessionOperation = true, $cascading = false )	Remove the item at absPath from local cache and keep information for undo.
performPropertyRemove ( string $absPath, PHPCR\PropertyInterface $property, boolean $sessionOperation = true )	Remove the item at absPath from local cache and keep information for undo.
rewriteItemPaths ( string $curPath, string $newPath )	Rewrites the path of a node for the movement operation, also updating all cached children.

Приватные методы

Метод	Описание
getMoveSrcPath ( string $dstPath ) : string | boolean	Get the src path of a move operation knowing the target path.
matchNodeType ( PHPCR\NodeInterface $node, array $typeFilter ) : boolean	Check if a node is of any of the types listed in typeFilter.

Описание методов

Описание свойств