PHP Class eZ\Publish\Core\Repository\Repository

Inheritance: implements eZ\Publish\API\Repository\Repository

Show file Open project: ezsystems/ezpublish-kernel Class Usage Examples

Protected Properties

Property	Type	Description
$commitEventsQueue	array	Array of arrays of commit events indexed by the transaction count.
$contentService	eZ\Publish\API\Repository\ContentService	Instance of content service.
$contentTypeDomainMapper	eZ\Publish\Core\Repository\Helper\ContentTypeDomainMapper	Instance of content type domain mapper.
$contentTypeService	eZ\Publish\API\Repository\ContentTypeService	Instance of content type service.
$currentUser	eZ\Publish\API\Repository\Values\User\User \| null
$currentUserRef	eZ\Publish\API\Repository\Values\User\UserReference
$domainMapper	eZ\Publish\Core\Repository\Helper\DomainMapper	Instance of domain mapper.
$fieldTypeService	eZ\Publish\API\Repository\FieldTypeService	Instance of field type service.
$languageService	eZ\Publish\API\Repository\LanguageService	Instance of language service.
$limitationService	eZ\Publish\Core\Repository\Helper\LimitationService	Instance of role service.
$locationService	eZ\Publish\API\Repository\LocationService	Instance of location service.
$nameSchemaService	eZ\Publish\Core\Repository\Helper\NameSchemaService	Instance of name schema resolver service.
$objectStateService	eZ\Publish\API\Repository\ObjectStateService	Instance of object state service.
$permissionResolver	eZ\Publish\Core\Repository\Permission\PermissionResolver	Instance of permission service.
$permissionsCriterionHandler	PermissionsCriterionHandler	Instance of permissions criterion handler.
$persistenceHandler	eZ\Publish\SPI\Persistence\Handler	Repository Handler object.
$relationProcessor	eZ\Publish\Core\Repository\Helper\RelationProcessor	Instance of relation processor service.
$roleDomainMapper	eZ\Publish\Core\Repository\Helper\RoleDomainMapper
$roleService	eZ\Publish\API\Repository\RoleService	Instance of role service.
$searchHandler	eZ\Publish\SPI\Search\Handler	Instance of main Search Handler.
$searchService	eZ\Publish\API\Repository\SearchService	Instance of search service.
$sectionService	eZ\Publish\API\Repository\SectionService	Instance of section service.
$serviceSettings	array	Service settings, first level key is service name.
$transactionDepth	integer
$trashService	eZ\Publish\API\Repository\TrashService	Instance of Trash service.
$urlAliasService	URLAliasService	Instance of URL alias service.
$urlWildcardService	URLWildcardService	Instance of URL wildcard service.
$userService	eZ\Publish\API\Repository\UserService	Instance of user service.

Public Methods

Method	Description
__construct ( eZ\Publish\SPI\Persistence\Handler $persistenceHandler, eZ\Publish\SPI\Search\Handler $searchHandler, array $serviceSettings = [], eZ\Publish\API\Repository\Values\User\UserReference $user = null )	Constructor.
beginTransaction ( )	Begin transaction.
canUser ( string $module, string $function, eZ\Publish\API\Repository\Values\ValueObject $object, mixed $targets = null ) : boolean
commit ( )	Commit transaction.
commitEvent ( Callable $event )	Enqueue an event to be triggered at commit or directly if no transaction has started.
createDateTime ( integer $timestamp = null ) : DateTime	Only for internal use.
getContentLanguageService ( ) : eZ\Publish\API\Repository\LanguageService	Get Content Language Service.
getContentService ( ) : eZ\Publish\API\Repository\ContentService	Get Content Service.
getContentTypeService ( ) : eZ\Publish\API\Repository\ContentTypeService	Get Content Type Service.
getCurrentUser ( ) : eZ\Publish\API\Repository\Values\User\User
getCurrentUserReference ( ) : eZ\Publish\API\Repository\Values\User\UserReference
getFieldTypeService ( ) : eZ\Publish\API\Repository\FieldTypeService	Get FieldTypeService.
getLocationService ( ) : eZ\Publish\API\Repository\LocationService	Get Content Location Service.
getNameSchemaService ( ) : NameSchemaService	Get NameSchemaResolverService.
getObjectStateService ( ) : eZ\Publish\API\Repository\ObjectStateService	Get ObjectStateService.
getPermissionResolver ( ) : eZ\Publish\API\Repository\PermissionResolver	Get PermissionResolver.
getRoleService ( ) : eZ\Publish\API\Repository\RoleService	Get RoleService.
getSearchService ( ) : eZ\Publish\API\Repository\SearchService	Get SearchService.
getSectionService ( ) : eZ\Publish\API\Repository\SectionService	Get Content Section Service.
getTrashService ( ) : eZ\Publish\API\Repository\TrashService	Get Content Trash service.
getURLAliasService ( ) : eZ\Publish\API\Repository\URLAliasService	Get URLAliasService.
getURLWildcardService ( ) : eZ\Publish\API\Repository\URLWildcardService	Get URLWildcardService.
getUserService ( ) : eZ\Publish\API\Repository\UserService	Get User Service.
hasAccess ( string $module, string $function, eZ\Publish\API\Repository\Values\User\UserReference $user = null ) : boolean \| array
rollback ( )	Rollback transaction.
setCurrentUser ( eZ\Publish\API\Repository\Values\User\UserReference $user )
sudo ( Closure $callback, eZ\Publish\API\Repository\Repository $outerRepository = null ) : mixed	Allows API execution to be performed with full access sand-boxed.

Protected Methods

Method	Description
getContentTypeDomainMapper ( ) : ContentTypeDomainMapper	Get ContentType Domain Mapper.
getDomainMapper ( ) : DomainMapper	Get Content Domain Mapper.
getFieldTypeRegistry ( ) : FieldTypeRegistry
getLimitationService ( ) : LimitationService	Get LimitationService.
getNameableFieldTypeRegistry ( ) : NameableFieldTypeRegistry
getPermissionsCriterionHandler ( ) : PermissionsCriterionHandler	Get PermissionsCriterionHandler.
getRelationProcessor ( ) : RelationProcessor	Get RelationProcessor.
getRoleDomainMapper ( ) : RoleDomainMapper	Get RoleDomainMapper.

Method Details

__construct() public method

Construct repository object with provided storage engine

public __construct ( eZ\Publish\SPI\Persistence\Handler $persistenceHandler, eZ\Publish\SPI\Search\Handler $searchHandler, array $serviceSettings = [], eZ\Publish\API\Repository\Values\User\UserReference $user = null )
$persistenceHandler	eZ\Publish\SPI\Persistence\Handler
$searchHandler	eZ\Publish\SPI\Search\Handler
$serviceSettings	array
$user	eZ\Publish\API\Repository\Values\User\UserReference

beginTransaction() public method

Begins an transaction, make sure you'll call commit or rollback when done, otherwise work will be lost.

public beginTransaction ( )

canUser() public method

Deprecation: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given objects.

public canUser ( string $module, string $function, eZ\Publish\API\Repository\Values\ValueObject $object, mixed $targets = null ) : boolean
$module	string	The module, aka controller identifier to check permissions on
$function	string	The function, aka the controller action to check permissions on
$object	eZ\Publish\API\Repository\Values\ValueObject	The object to check if the user has access to
$targets	mixed	The location, parent or "assignment" value object, or an array of the same
return	boolean

commit() public method

Commit transaction, or throw exceptions if no transactions has been started.

public commit ( )

commitEvent() public method

Enqueue an event to be triggered at commit or directly if no transaction has started.

public commitEvent ( Callable $event )
$event	Callable

createDateTime() public method

Creates a \DateTime object for $timestamp in the current time zone

public createDateTime ( integer $timestamp = null ) : DateTime
$timestamp	integer
return	DateTime

getContentLanguageService() public method

Get service object to perform operations on Content language objects

public getContentLanguageService ( ) : eZ\Publish\API\Repository\LanguageService
return	eZ\Publish\API\Repository\LanguageService

getContentService() public method

Get service object to perform operations on Content objects and it's aggregate members.

public getContentService ( ) : eZ\Publish\API\Repository\ContentService
return	eZ\Publish\API\Repository\ContentService

getContentTypeDomainMapper() protected method

Get ContentType Domain Mapper.

protected getContentTypeDomainMapper ( ) : ContentTypeDomainMapper
return	eZ\Publish\Core\Repository\Helper\ContentTypeDomainMapper

getContentTypeService() public method

Get service object to perform operations on Content Type objects and it's aggregate members. ( Group, Field & FieldCategory )

public getContentTypeService ( ) : eZ\Publish\API\Repository\ContentTypeService
return	eZ\Publish\API\Repository\ContentTypeService

getCurrentUser() public method

Deprecation: since 6.6, to be removed. Use PermissionResolver::getCurrentUserReference() instead. Get current user. Loads the full user object if not already loaded, if you only need to know user id use {@see \getCurrentUserReference()}

public getCurrentUser ( ) : eZ\Publish\API\Repository\Values\User\User
return	eZ\Publish\API\Repository\Values\User\User

getCurrentUserReference() public method

Deprecation: since 6.6, to be removed. Use PermissionResolver::getCurrentUserReference() instead. Get current user reference.

Since: 5.4.5

public getCurrentUserReference ( ) : eZ\Publish\API\Repository\Values\User\UserReference
return	eZ\Publish\API\Repository\Values\User\UserReference

getDomainMapper() protected method

Get Content Domain Mapper.

protected getDomainMapper ( ) : DomainMapper
return	eZ\Publish\Core\Repository\Helper\DomainMapper

getFieldTypeRegistry() protected method

protected getFieldTypeRegistry ( ) : FieldTypeRegistry
return	eZ\Publish\Core\Repository\Helper\FieldTypeRegistry

getFieldTypeService() public method

Get FieldTypeService.

public getFieldTypeService ( ) : eZ\Publish\API\Repository\FieldTypeService
return	eZ\Publish\API\Repository\FieldTypeService

getLimitationService() protected method

Get LimitationService.

protected getLimitationService ( ) : LimitationService
return	eZ\Publish\Core\Repository\Helper\LimitationService

getLocationService() public method

Get service object to perform operations on Location objects and subtrees

public getLocationService ( ) : eZ\Publish\API\Repository\LocationService
return	eZ\Publish\API\Repository\LocationService

getNameSchemaService() public method

Get NameSchemaResolverService.

public getNameSchemaService ( ) : NameSchemaService
return	eZ\Publish\Core\Repository\Helper\NameSchemaService

getNameableFieldTypeRegistry() protected method

protected getNameableFieldTypeRegistry ( ) : NameableFieldTypeRegistry
return	eZ\Publish\Core\Repository\Helper\NameableFieldTypeRegistry

getObjectStateService() public method

Get ObjectStateService.

public getObjectStateService ( ) : eZ\Publish\API\Repository\ObjectStateService
return	eZ\Publish\API\Repository\ObjectStateService

getPermissionResolver() public method

Get PermissionResolver.

public getPermissionResolver ( ) : eZ\Publish\API\Repository\PermissionResolver
return	eZ\Publish\API\Repository\PermissionResolver

getPermissionsCriterionHandler() protected method

Get PermissionsCriterionHandler.

protected getPermissionsCriterionHandler ( ) : PermissionsCriterionHandler
return	PermissionsCriterionHandler

getRelationProcessor() protected method

Get RelationProcessor.

protected getRelationProcessor ( ) : RelationProcessor
return	eZ\Publish\Core\Repository\Helper\RelationProcessor

getRoleDomainMapper() protected method

Get RoleDomainMapper.

protected getRoleDomainMapper ( ) : RoleDomainMapper
return	eZ\Publish\Core\Repository\Helper\RoleDomainMapper

getRoleService() public method

Get RoleService.

public getRoleService ( ) : eZ\Publish\API\Repository\RoleService
return	eZ\Publish\API\Repository\RoleService

getSearchService() public method

Get SearchService.

public getSearchService ( ) : eZ\Publish\API\Repository\SearchService
return	eZ\Publish\API\Repository\SearchService

getSectionService() public method

Get Section service that lets you manipulate section objects

public getSectionService ( ) : eZ\Publish\API\Repository\SectionService
return	eZ\Publish\API\Repository\SectionService

getTrashService() public method

Trash service allows to perform operations related to location trash (trash/untrash, load/list from trash...)

public getTrashService ( ) : eZ\Publish\API\Repository\TrashService
return	eZ\Publish\API\Repository\TrashService

getURLAliasService() public method

Get URLAliasService.

public getURLAliasService ( ) : eZ\Publish\API\Repository\URLAliasService
return	eZ\Publish\API\Repository\URLAliasService

getURLWildcardService() public method

Get URLWildcardService.

public getURLWildcardService ( ) : eZ\Publish\API\Repository\URLWildcardService
return	eZ\Publish\API\Repository\URLWildcardService

getUserService() public method

Get service object to perform operations on Users and UserGroup

public getUserService ( ) : eZ\Publish\API\Repository\UserService
return	eZ\Publish\API\Repository\UserService

hasAccess() public method

Deprecation: since 6.6, to be removed. Use PermissionResolver::hasAccess() instead. Check if user has access to a given module / function. Low level function, use canUser instead if you have objects to check against.

public hasAccess ( string $module, string $function, eZ\Publish\API\Repository\Values\User\UserReference $user = null ) : boolean \| array
$module	string
$function	string
$user	eZ\Publish\API\Repository\Values\User\UserReference
return	boolean \| array	Bool if user has full or no access, array if limitations if not

rollback() public method

Rollback transaction, or throw exceptions if no transactions has been started.

public rollback ( )

setCurrentUser() public method

Deprecation: since 6.6, to be removed. Use PermissionResolver::setCurrentUserReference() instead. Sets the current user to the given $user.

public setCurrentUser ( eZ\Publish\API\Repository\Values\User\UserReference $user )
$user	eZ\Publish\API\Repository\Values\User\UserReference

sudo() public method

The closure sandbox will do a catch all on exceptions and rethrow after re-setting the sudo flag. Example use: $location = $repository->sudo( function ( Repository $repo ) use ( $locationId ) { return $repo->getLocationService()->loadLocation( $locationId ) } );

public sudo ( Closure $callback, eZ\Publish\API\Repository\Repository $outerRepository = null ) : mixed
$callback	Closure
$outerRepository	eZ\Publish\API\Repository\Repository
return	mixed

Property Details

$commitEventsQueue protected property

Array of arrays of commit events indexed by the transaction count.

protected array $commitEventsQueue
return	array

$contentService protected property

Instance of content service.

protected ContentService,eZ\Publish\API\Repository $contentService
return	eZ\Publish\API\Repository\ContentService

$contentTypeDomainMapper protected property

Instance of content type domain mapper.

protected ContentTypeDomainMapper,eZ\Publish\Core\Repository\Helper $contentTypeDomainMapper
return	eZ\Publish\Core\Repository\Helper\ContentTypeDomainMapper

$contentTypeService protected property

Instance of content type service.

protected ContentTypeService,eZ\Publish\API\Repository $contentTypeService
return	eZ\Publish\API\Repository\ContentTypeService

$currentUser protected property

Deprecation: since 6.6, to be removed. Current user handling is moved to PermissionResolver. Currently logged in user object if already loaded.

protected User,eZ\Publish\API\Repository\Values\User\|null $currentUser
return	eZ\Publish\API\Repository\Values\User\User \| null

$currentUserRef protected property

Deprecation: since 6.6, to be removed. Current user handling is moved to PermissionResolver. Currently logged in user reference for permission purposes.

protected UserReference,eZ\Publish\API\Repository\Values\User $currentUserRef
return	eZ\Publish\API\Repository\Values\User\UserReference

$domainMapper protected property

Instance of domain mapper.

protected DomainMapper,eZ\Publish\Core\Repository\Helper $domainMapper
return	eZ\Publish\Core\Repository\Helper\DomainMapper

$fieldTypeService protected property

Instance of field type service.

protected FieldTypeService,eZ\Publish\API\Repository $fieldTypeService
return	eZ\Publish\API\Repository\FieldTypeService

$languageService protected property

Instance of language service.

protected LanguageService,eZ\Publish\API\Repository $languageService
return	eZ\Publish\API\Repository\LanguageService

$limitationService protected property

Instance of role service.

protected LimitationService,eZ\Publish\Core\Repository\Helper $limitationService
return	eZ\Publish\Core\Repository\Helper\LimitationService

$locationService protected property

Instance of location service.

protected LocationService,eZ\Publish\API\Repository $locationService
return	eZ\Publish\API\Repository\LocationService

$nameSchemaService protected property

Instance of name schema resolver service.

protected NameSchemaService,eZ\Publish\Core\Repository\Helper $nameSchemaService
return	eZ\Publish\Core\Repository\Helper\NameSchemaService

$objectStateService protected property

Instance of object state service.

protected ObjectStateService,eZ\Publish\API\Repository $objectStateService
return	eZ\Publish\API\Repository\ObjectStateService

$permissionResolver protected property

Instance of permission service.

protected PermissionResolver,eZ\Publish\Core\Repository\Permission $permissionResolver
return	eZ\Publish\Core\Repository\Permission\PermissionResolver

$permissionsCriterionHandler protected property

Instance of permissions criterion handler.

protected PermissionsCriterionHandler,eZ\Publish\Core\Repository $permissionsCriterionHandler
return	PermissionsCriterionHandler

$persistenceHandler protected property

Repository Handler object.

protected Handler,eZ\Publish\SPI\Persistence $persistenceHandler
return	eZ\Publish\SPI\Persistence\Handler

$relationProcessor protected property

Instance of relation processor service.

protected RelationProcessor,eZ\Publish\Core\Repository\Helper $relationProcessor
return	eZ\Publish\Core\Repository\Helper\RelationProcessor

$roleDomainMapper protected property

protected RoleDomainMapper,eZ\Publish\Core\Repository\Helper $roleDomainMapper
return	eZ\Publish\Core\Repository\Helper\RoleDomainMapper

$roleService protected property

Instance of role service.

protected RoleService,eZ\Publish\API\Repository $roleService
return	eZ\Publish\API\Repository\RoleService

$searchHandler protected property

Instance of main Search Handler.

protected Handler,eZ\Publish\SPI\Search $searchHandler
return	eZ\Publish\SPI\Search\Handler

$searchService protected property

Instance of search service.

protected SearchService,eZ\Publish\API\Repository $searchService
return	eZ\Publish\API\Repository\SearchService

$sectionService protected property

Instance of section service.

protected SectionService,eZ\Publish\API\Repository $sectionService
return	eZ\Publish\API\Repository\SectionService

$serviceSettings protected property

Service settings, first level key is service name.

protected array $serviceSettings
return	array

$transactionDepth protected property

protected int $transactionDepth
return	integer

$trashService protected property

Instance of Trash service.

protected TrashService,eZ\Publish\API\Repository $trashService
return	eZ\Publish\API\Repository\TrashService

$urlAliasService protected property

Instance of URL alias service.

protected URLAliasService,eZ\Publish\Core\Repository $urlAliasService
return	URLAliasService

$urlWildcardService protected property

Instance of URL wildcard service.

protected URLWildcardService,eZ\Publish\Core\Repository $urlWildcardService
return	URLWildcardService

$userService protected property

Instance of user service.

protected UserService,eZ\Publish\API\Repository $userService
return	eZ\Publish\API\Repository\UserService