PHP 클래스 eZ\Publish\Core\Repository\LocationService

상속: implements eZ\Publish\API\Repository\LocationService

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

보호된 프로퍼티들

프로퍼티	타입	설명
$domainMapper	eZ\Publish\Core\Repository\Helper\DomainMapper
$nameSchemaService	eZ\Publish\Core\Repository\Helper\NameSchemaService
$permissionsCriterionHandler	PermissionsCriterionHandler
$persistenceHandler	eZ\Publish\SPI\Persistence\Handler
$repository	Repository
$settings	array

공개 메소드들

메소드	설명
__construct ( eZ\Publish\API\Repository\Repository $repository, eZ\Publish\SPI\Persistence\Handler $handler, DomainMapper $domainMapper, NameSchemaService $nameSchemaService, PermissionsCriterionHandler $permissionsCriterionHandler, array $settings = [] )	Setups service with reference to repository object that created it & corresponding handler.
copySubtree ( eZ\Publish\API\Repository\Values\Content\Location $subtree, eZ\Publish\API\Repository\Values\Content\Location $targetParentLocation ) : eZ\Publish\API\Repository\Values\Content\Location	Copies the subtree starting from $subtree as a new subtree of $targetLocation.
createLocation ( eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo, eZ\Publish\API\Repository\Values\Content\LocationCreateStruct $locationCreateStruct ) : eZ\Publish\API\Repository\Values\Content\Location	Creates the new $location in the content repository for the given content.
deleteLocation ( eZ\Publish\API\Repository\Values\Content\Location $location )	Deletes $location and all its descendants.
getLocationChildCount ( eZ\Publish\API\Repository\Values\Content\Location $location ) : integer	Returns the number of children which are readable by the current user of a location object.
hideLocation ( eZ\Publish\API\Repository\Values\Content\Location $location ) : eZ\Publish\API\Repository\Values\Content\Location	Hides the $location and marks invisible all descendants of $location.
loadLocation ( mixed $locationId ) : eZ\Publish\API\Repository\Values\Content\Location	Loads a location object from its $locationId.
loadLocationByRemoteId ( string $remoteId ) : eZ\Publish\API\Repository\Values\Content\Location	Loads a location object from its $remoteId.
loadLocationChildren ( eZ\Publish\API\Repository\Values\Content\Location $location, integer $offset, integer $limit = 25 ) : eZ\Publish\API\Repository\Values\Content\LocationList	Loads children which are readable by the current user of a location object sorted by sortField and sortOrder.
loadLocations ( eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo, eZ\Publish\API\Repository\Values\Content\Location $rootLocation = null ) : eZ\Publish\API\Repository\Values\Content\Location[]	Loads the locations for the given content object.
moveSubtree ( eZ\Publish\API\Repository\Values\Content\Location $location, eZ\Publish\API\Repository\Values\Content\Location $newParentLocation )	Moves the subtree to $newParentLocation.
newLocationCreateStruct ( mixed $parentLocationId ) : eZ\Publish\API\Repository\Values\Content\LocationCreateStruct	Instantiates a new location create class.
newLocationUpdateStruct ( ) : eZ\Publish\API\Repository\Values\Content\LocationUpdateStruct	Instantiates a new location update class.
swapLocation ( eZ\Publish\API\Repository\Values\Content\Location $location1, eZ\Publish\API\Repository\Values\Content\Location $location2 )	Swaps the contents held by $location1 and $location2.
unhideLocation ( eZ\Publish\API\Repository\Values\Content\Location $location ) : eZ\Publish\API\Repository\Values\Content\Location	Unhides the $location.
updateLocation ( eZ\Publish\API\Repository\Values\Content\Location $location, eZ\Publish\API\Repository\Values\Content\LocationUpdateStruct $locationUpdateStruct ) : eZ\Publish\API\Repository\Values\Content\Location	Updates $location in the content repository.

보호된 메소드들

메소드	설명
searchChildrenLocations ( eZ\Publish\API\Repository\Values\Content\Location $location, integer $offset, integer $limit ) : eZ\Publish\API\Repository\Values\Content\Search\SearchResult	Searches children locations of the provided parent location id.

메소드 상세

__construct() 공개 메소드

Setups service with reference to repository object that created it & corresponding handler.

public __construct ( eZ\Publish\API\Repository\Repository $repository, eZ\Publish\SPI\Persistence\Handler $handler, DomainMapper $domainMapper, NameSchemaService $nameSchemaService, PermissionsCriterionHandler $permissionsCriterionHandler, array $settings = [] )
$repository	eZ\Publish\API\Repository\Repository
$handler	eZ\Publish\SPI\Persistence\Handler
$domainMapper	eZ\Publish\Core\Repository\Helper\DomainMapper
$nameSchemaService	eZ\Publish\Core\Repository\Helper\NameSchemaService
$permissionsCriterionHandler	PermissionsCriterionHandler
$settings	array

copySubtree() 공개 메소드

Only the items on which the user has read access are copied.

public copySubtree ( eZ\Publish\API\Repository\Values\Content\Location $subtree, eZ\Publish\API\Repository\Values\Content\Location $targetParentLocation ) : eZ\Publish\API\Repository\Values\Content\Location
$subtree	eZ\Publish\API\Repository\Values\Content\Location	- the subtree denoted by the location to copy
$targetParentLocation	eZ\Publish\API\Repository\Values\Content\Location	- the target parent location for the copy operation
리턴	eZ\Publish\API\Repository\Values\Content\Location	The newly created location of the copied subtree

createLocation() 공개 메소드

Creates the new $location in the content repository for the given content.

public createLocation ( eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo, eZ\Publish\API\Repository\Values\Content\LocationCreateStruct $locationCreateStruct ) : eZ\Publish\API\Repository\Values\Content\Location
$contentInfo	eZ\Publish\API\Repository\Values\Content\ContentInfo
$locationCreateStruct	eZ\Publish\API\Repository\Values\Content\LocationCreateStruct
리턴	eZ\Publish\API\Repository\Values\Content\Location	the newly created Location

deleteLocation() 공개 메소드

Deletes $location and all its descendants.

public deleteLocation ( eZ\Publish\API\Repository\Values\Content\Location $location )
$location	eZ\Publish\API\Repository\Values\Content\Location

getLocationChildCount() 공개 메소드

Returns the number of children which are readable by the current user of a location object.

public getLocationChildCount ( eZ\Publish\API\Repository\Values\Content\Location $location ) : integer
$location	eZ\Publish\API\Repository\Values\Content\Location
리턴	integer

hideLocation() 공개 메소드

Hides the $location and marks invisible all descendants of $location.

public hideLocation ( eZ\Publish\API\Repository\Values\Content\Location $location ) : eZ\Publish\API\Repository\Values\Content\Location
$location	eZ\Publish\API\Repository\Values\Content\Location
리턴	eZ\Publish\API\Repository\Values\Content\Location	$location, with updated hidden value

loadLocation() 공개 메소드

Loads a location object from its $locationId.

public loadLocation ( mixed $locationId ) : eZ\Publish\API\Repository\Values\Content\Location
$locationId	mixed
리턴	eZ\Publish\API\Repository\Values\Content\Location

loadLocationByRemoteId() 공개 메소드

Loads a location object from its $remoteId.

public loadLocationByRemoteId ( string $remoteId ) : eZ\Publish\API\Repository\Values\Content\Location
$remoteId	string
리턴	eZ\Publish\API\Repository\Values\Content\Location

loadLocationChildren() 공개 메소드

Loads children which are readable by the current user of a location object sorted by sortField and sortOrder.

public loadLocationChildren ( eZ\Publish\API\Repository\Values\Content\Location $location, integer $offset, integer $limit = 25 ) : eZ\Publish\API\Repository\Values\Content\LocationList
$location	eZ\Publish\API\Repository\Values\Content\Location
$offset	integer	the start offset for paging
$limit	integer	the number of locations returned
리턴	eZ\Publish\API\Repository\Values\Content\LocationList

loadLocations() 공개 메소드

If a $rootLocation is given, only locations that belong to this location are returned. The location list is also filtered by permissions on reading locations.

public loadLocations ( eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo, eZ\Publish\API\Repository\Values\Content\Location $rootLocation = null ) : eZ\Publish\API\Repository\Values\Content\Location[]
$contentInfo	eZ\Publish\API\Repository\Values\Content\ContentInfo
$rootLocation	eZ\Publish\API\Repository\Values\Content\Location
리턴	eZ\Publish\API\Repository\Values\Content\Location[]	An array of {@link Location}

moveSubtree() 공개 메소드

If a user has the permission to move the location to a target location he can do it regardless of an existing descendant on which the user has no permission.

public moveSubtree ( eZ\Publish\API\Repository\Values\Content\Location $location, eZ\Publish\API\Repository\Values\Content\Location $newParentLocation )
$location	eZ\Publish\API\Repository\Values\Content\Location
$newParentLocation	eZ\Publish\API\Repository\Values\Content\Location

newLocationCreateStruct() 공개 메소드

Instantiates a new location create class.

public newLocationCreateStruct ( mixed $parentLocationId ) : eZ\Publish\API\Repository\Values\Content\LocationCreateStruct
$parentLocationId	mixed	the parent under which the new location should be created
리턴	eZ\Publish\API\Repository\Values\Content\LocationCreateStruct

newLocationUpdateStruct() 공개 메소드

Instantiates a new location update class.

public newLocationUpdateStruct ( ) : eZ\Publish\API\Repository\Values\Content\LocationUpdateStruct
리턴	eZ\Publish\API\Repository\Values\Content\LocationUpdateStruct

searchChildrenLocations() 보호된 메소드

Searches children locations of the provided parent location id.

protected searchChildrenLocations ( eZ\Publish\API\Repository\Values\Content\Location $location, integer $offset, integer $limit ) : eZ\Publish\API\Repository\Values\Content\Search\SearchResult
$location	eZ\Publish\API\Repository\Values\Content\Location
$offset	integer
$limit	integer
리턴	eZ\Publish\API\Repository\Values\Content\Search\SearchResult

swapLocation() 공개 메소드

Swaps the contents held by $location1 and $location2.

public swapLocation ( eZ\Publish\API\Repository\Values\Content\Location $location1, eZ\Publish\API\Repository\Values\Content\Location $location2 )
$location1	eZ\Publish\API\Repository\Values\Content\Location
$location2	eZ\Publish\API\Repository\Values\Content\Location

unhideLocation() 공개 메소드

This method and marks visible all descendants of $locations until a hidden location is found.

public unhideLocation ( eZ\Publish\API\Repository\Values\Content\Location $location ) : eZ\Publish\API\Repository\Values\Content\Location
$location	eZ\Publish\API\Repository\Values\Content\Location
리턴	eZ\Publish\API\Repository\Values\Content\Location	$location, with updated hidden value

updateLocation() 공개 메소드

Updates $location in the content repository.

public updateLocation ( eZ\Publish\API\Repository\Values\Content\Location $location, eZ\Publish\API\Repository\Values\Content\LocationUpdateStruct $locationUpdateStruct ) : eZ\Publish\API\Repository\Values\Content\Location
$location	eZ\Publish\API\Repository\Values\Content\Location
$locationUpdateStruct	eZ\Publish\API\Repository\Values\Content\LocationUpdateStruct
리턴	eZ\Publish\API\Repository\Values\Content\Location	the updated Location

프로퍼티 상세

$domainMapper 보호되어 있는 프로퍼티

protected DomainMapper,eZ\Publish\Core\Repository\Helper $domainMapper
리턴	eZ\Publish\Core\Repository\Helper\DomainMapper

$nameSchemaService 보호되어 있는 프로퍼티

protected NameSchemaService,eZ\Publish\Core\Repository\Helper $nameSchemaService
리턴	eZ\Publish\Core\Repository\Helper\NameSchemaService

$permissionsCriterionHandler 보호되어 있는 프로퍼티

protected PermissionsCriterionHandler,eZ\Publish\Core\Repository $permissionsCriterionHandler
리턴	PermissionsCriterionHandler

$persistenceHandler 보호되어 있는 프로퍼티

protected Handler,eZ\Publish\SPI\Persistence $persistenceHandler
리턴	eZ\Publish\SPI\Persistence\Handler

$repository 보호되어 있는 프로퍼티

protected Repository,eZ\Publish\Core\Repository $repository
리턴	Repository

$settings 보호되어 있는 프로퍼티

protected array $settings
리턴	array