PHP 클래스 eZ\Publish\Core\Persistence\Legacy\Content\Location\Gateway

파일 보기 프로젝트 열기: ezsystems/ezpublish-kernel 1 사용 예제들

공개 메소드들

메소드 설명
changeMainLocation ( mixed $contentId, mixed $locationId, mixed $versionNo, mixed $parentLocationId ) Changes main location of content identified by given $contentId to location identified by given $locationId.
cleanupTrash ( ) Removes every entries in the trash.
countLocationsByContentId ( integer $contentId ) : integer Returns how many locations given content object identified by $contentId has.
create ( eZ\Publish\SPI\Persistence\Content\Location\CreateStruct $createStruct, array $parentNode ) : eZ\Publish\SPI\Persistence\Content\Location Creates a new location in given $parentNode.
createLocationsFromNodeAssignments ( mixed $contentId, mixed $versionNo ) Create locations from node assignments.
createNodeAssignment ( eZ\Publish\SPI\Persistence\Content\Location\CreateStruct $createStruct, mixed $parentNodeId, integer $type = self::NODE_ASSIGNMENT_OP_CODE_CREATE_NOP ) Create an entry in the node assignment table.
deleteNodeAssignment ( integer $contentId, integer $versionNo = null ) Deletes node assignment for given $contentId and $versionNo.
getBasicNodeData ( mixed $nodeId ) : array Returns an array with basic node data.
getBasicNodeDataByRemoteId ( mixed $remoteId ) : array Returns an array with basic node data for the node with $remoteId.
getChildren ( mixed $locationId ) : array Returns data for the first level children of the location identified by given $locationId.
getFallbackMainNodeData ( mixed $contentId, mixed $locationId ) : array Returns id of the next in line node to be set as a new main node.
getSubtreeContent ( mixed $sourceId, boolean $onlyIds = false ) : array Find all content in the given subtree.
hideSubtree ( string $pathString ) Sets a location to be hidden, and it self + all children to invisible.
listTrashed ( integer $offset, integer $limit, array $sort = null ) : array Lists trashed items.
loadLocationDataByContent ( integer $contentId, integer $rootLocationId = null ) : array Loads data for all Locations for $contentId, optionally only in the subtree starting at $rootLocationId.
loadParentLocationsDataForDraftContent ( mixed $contentId ) : array Loads data for all parent Locations for unpublished Content by given $contentId.
loadTrashByLocation ( mixed $locationId ) : array Loads trash data specified by location ID.
moveSubtreeNodes ( array $fromPathString, array $toPathString ) Update path strings to move nodes in the ezcontentobject_tree table.
removeElementFromTrash ( integer $id ) Removes trashed element identified by $id from trash.
removeLocation ( mixed $locationId ) Deletes ezcontentobject_tree row for given $locationId (node_id).
setSectionForSubtree ( mixed $pathString, mixed $sectionId ) : boolean Set section on all content objects in the subtree.
swap ( mixed $locationId1, mixed $locationId2 ) : boolean Swaps the content object being pointed to by a location object.
trashLocation ( mixed $locationId ) : boolean Sends a single location identified by given $locationId to the trash.
unHideSubtree ( string $pathString ) Sets a location to be unhidden, and self + children to visible unless a parent is hiding the tree.
untrashLocation ( mixed $locationId, mixed $newParentId = null ) : eZ\Publish\SPI\Persistence\Content\Location Returns a trashed location to normal state.
update ( eZ\Publish\SPI\Persistence\Content\Location\UpdateStruct $location, integer $locationId ) Updates an existing location.
updateLocationsContentVersionNo ( mixed $contentId, mixed $versionNo ) Updates all Locations of content identified with $contentId with $versionNo.
updateNodeAssignment ( integer $contentObjectId, integer $oldParent, integer $newParent, integer $opcode ) Update node assignment table.
updatePathIdentificationString ( mixed $locationId, mixed $parentLocationId, string $text ) Updates path identification string for given $locationId.
updateSubtreeModificationTime ( string $pathString, integer | null $timestamp = null ) Updated subtree modification time for all nodes on path.

메소드 상세

changeMainLocation() 추상적인 공개 메소드

Updates ezcontentobject_tree table for the given $contentId and eznode_assignment table for the given $contentId, $parentLocationId and $versionNo
abstract public changeMainLocation ( mixed $contentId, mixed $locationId, mixed $versionNo, mixed $parentLocationId )
$contentId mixed
$locationId mixed
$versionNo mixed version number, needed to update eznode_assignment table
$parentLocationId mixed parent location of location identified by $locationId, needed to update eznode_assignment table

cleanupTrash() 추상적인 공개 메소드

Will NOT remove associated content objects nor attributes. Basically truncates ezcontentobject_trash table.
abstract public cleanupTrash ( )

countLocationsByContentId() 추상적인 공개 메소드

Returns how many locations given content object identified by $contentId has.
abstract public countLocationsByContentId ( integer $contentId ) : integer
$contentId integer
리턴 integer

create() 추상적인 공개 메소드

Creates a new location in given $parentNode.
abstract public create ( eZ\Publish\SPI\Persistence\Content\Location\CreateStruct $createStruct, array $parentNode ) : eZ\Publish\SPI\Persistence\Content\Location
$createStruct eZ\Publish\SPI\Persistence\Content\Location\CreateStruct
$parentNode array
리턴 eZ\Publish\SPI\Persistence\Content\Location

createLocationsFromNodeAssignments() 추상적인 공개 메소드

Convert existing node assignments into real locations.
abstract public createLocationsFromNodeAssignments ( mixed $contentId, mixed $versionNo )
$contentId mixed
$versionNo mixed

createNodeAssignment() 추상적인 공개 메소드

Create an entry in the node assignment table.
abstract public createNodeAssignment ( eZ\Publish\SPI\Persistence\Content\Location\CreateStruct $createStruct, mixed $parentNodeId, integer $type = self::NODE_ASSIGNMENT_OP_CODE_CREATE_NOP )
$createStruct eZ\Publish\SPI\Persistence\Content\Location\CreateStruct
$parentNodeId mixed
$type integer

deleteNodeAssignment() 추상적인 공개 메소드

Deletes node assignment for given $contentId and $versionNo.
abstract public deleteNodeAssignment ( integer $contentId, integer $versionNo = null )
$contentId integer
$versionNo integer

getBasicNodeData() 추상적인 공개 메소드

We might want to cache this, since this method is used by about every method in the location handler.
abstract public getBasicNodeData ( mixed $nodeId ) : array
$nodeId mixed
리턴 array

getBasicNodeDataByRemoteId() 추상적인 공개 메소드

Returns an array with basic node data for the node with $remoteId.
abstract public getBasicNodeDataByRemoteId ( mixed $remoteId ) : array
$remoteId mixed
리턴 array

getChildren() 추상적인 공개 메소드

Returns data for the first level children of the location identified by given $locationId.
abstract public getChildren ( mixed $locationId ) : array
$locationId mixed
리턴 array

getFallbackMainNodeData() 추상적인 공개 메소드

This returns lowest node id for content identified by $contentId, and not of the node identified by given $locationId (current main node). Assumes that content has more than one location.
abstract public getFallbackMainNodeData ( mixed $contentId, mixed $locationId ) : array
$contentId mixed
$locationId mixed
리턴 array

getSubtreeContent() 추상적인 공개 메소드

Find all content in the given subtree.
abstract public getSubtreeContent ( mixed $sourceId, boolean $onlyIds = false ) : array
$sourceId mixed
$onlyIds boolean
리턴 array

hideSubtree() 추상적인 공개 메소드

Sets a location to be hidden, and it self + all children to invisible.
abstract public hideSubtree ( string $pathString )
$pathString string

listTrashed() 추상적인 공개 메소드

Returns entries from ezcontentobject_trash.
abstract public listTrashed ( integer $offset, integer $limit, array $sort = null ) : array
$offset integer
$limit integer
$sort array
리턴 array

loadLocationDataByContent() 추상적인 공개 메소드

Loads data for all Locations for $contentId, optionally only in the subtree starting at $rootLocationId.
abstract public loadLocationDataByContent ( integer $contentId, integer $rootLocationId = null ) : array
$contentId integer
$rootLocationId integer
리턴 array

loadParentLocationsDataForDraftContent() 추상적인 공개 메소드

Loads data for all parent Locations for unpublished Content by given $contentId.
abstract public loadParentLocationsDataForDraftContent ( mixed $contentId ) : array
$contentId mixed
리턴 array

loadTrashByLocation() 추상적인 공개 메소드

Loads trash data specified by location ID.
abstract public loadTrashByLocation ( mixed $locationId ) : array
$locationId mixed
리턴 array

moveSubtreeNodes() 추상적인 공개 메소드

This query can likely be optimized to use some more advanced string operations, which then depend on the respective database.
abstract public moveSubtreeNodes ( array $fromPathString, array $toPathString )
$fromPathString array
$toPathString array

removeElementFromTrash() 추상적인 공개 메소드

Will NOT remove associated content object nor attributes.
abstract public removeElementFromTrash ( integer $id )
$id integer The trashed location Id

removeLocation() 추상적인 공개 메소드

Deletes ezcontentobject_tree row for given $locationId (node_id).
abstract public removeLocation ( mixed $locationId )
$locationId mixed

setSectionForSubtree() 추상적인 공개 메소드

Set section on all content objects in the subtree.
abstract public setSectionForSubtree ( mixed $pathString, mixed $sectionId ) : boolean
$pathString mixed
$sectionId mixed
리턴 boolean

swap() 추상적인 공개 메소드

Make the location identified by $locationId1 refer to the Content referred to by $locationId2 and vice versa.
abstract public swap ( mixed $locationId1, mixed $locationId2 ) : boolean
$locationId1 mixed
$locationId2 mixed
리턴 boolean

trashLocation() 추상적인 공개 메소드

The associated content object is left untouched.
abstract public trashLocation ( mixed $locationId ) : boolean
$locationId mixed
리턴 boolean

unHideSubtree() 추상적인 공개 메소드

If not make sure only children down to first hidden node is marked visible.
abstract public unHideSubtree ( string $pathString )
$pathString string

untrashLocation() 추상적인 공개 메소드

Recreates the originally trashed location in the new position. If no new position has been specified, it will be tried to re-create the location at the old position. If this is not possible ( because the old location does not exist any more) and exception is thrown.
abstract public untrashLocation ( mixed $locationId, mixed $newParentId = null ) : eZ\Publish\SPI\Persistence\Content\Location
$locationId mixed
$newParentId mixed
리턴 eZ\Publish\SPI\Persistence\Content\Location

update() 추상적인 공개 메소드

Will not throw anything if location id is invalid or no entries are affected.
abstract public update ( eZ\Publish\SPI\Persistence\Content\Location\UpdateStruct $location, integer $locationId )
$location eZ\Publish\SPI\Persistence\Content\Location\UpdateStruct
$locationId integer

updateLocationsContentVersionNo() 추상적인 공개 메소드

Updates all Locations of content identified with $contentId with $versionNo.
abstract public updateLocationsContentVersionNo ( mixed $contentId, mixed $versionNo )
$contentId mixed
$versionNo mixed

updateNodeAssignment() 추상적인 공개 메소드

Update node assignment table.
abstract public updateNodeAssignment ( integer $contentObjectId, integer $oldParent, integer $newParent, integer $opcode )
$contentObjectId integer
$oldParent integer
$newParent integer
$opcode integer

updatePathIdentificationString() 추상적인 공개 메소드

Updates path identification string for given $locationId.
abstract public updatePathIdentificationString ( mixed $locationId, mixed $parentLocationId, string $text )
$locationId mixed
$parentLocationId mixed
$text string

updateSubtreeModificationTime() 추상적인 공개 메소드

Updated subtree modification time for all nodes on path.
abstract public updateSubtreeModificationTime ( string $pathString, integer | null $timestamp = null )
$pathString string
$timestamp integer | null