PHP Class eZ\Publish\Core\SignalSlot\Repository

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

Mostrar archivo Open project: ezsystems/ezpublish-kernel Class Usage Examples

Protected Properties

Property	Type	Description
$contentService	eZ\Publish\API\Repository\ContentService	Instance of content service.
$contentTypeService	eZ\Publish\API\Repository\ContentTypeService	Instance of content type service.
$fieldTypeService	eZ\Publish\API\Repository\FieldTypeService	Instance of field type service.
$ioService	eZ\Publish\API\Repository\IOService	Instance of IO service.
$languageService	eZ\Publish\API\Repository\LanguageService	Instance of language service.
$locationService	eZ\Publish\API\Repository\LocationService	Instance of location service.
$objectStateService	eZ\Publish\API\Repository\ObjectStateService	Instance of object state service.
$repository	eZ\Publish\API\Repository\Repository	Repository Handler object.
$roleService	eZ\Publish\API\Repository\RoleService	Instance of role service.
$searchService	eZ\Publish\API\Repository\SearchService	Instance of search service.
$sectionService	eZ\Publish\API\Repository\SectionService	Instance of section service.
$signalDispatcher	SignalDispatcher	SignalDispatcher.
$trashService	eZ\Publish\API\Repository\TrashService	Instance of Trash service.
$urlAliasService	eZ\Publish\Core\Repository\URLAliasService	Instance of URL alias service.
$urlWildcardService	eZ\Publish\Core\Repository\URLWildcardService	Instance of URL wildcard service.
$userService	eZ\Publish\API\Repository\UserService	Instance of user service.

Public Methods

Method	Description
__construct ( eZ\Publish\API\Repository\Repository $repository, SignalDispatcher $signalDispatcher )	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.
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 ) : mixed	Allows API execution to be performed with full access sand-boxed.

Method Details

__construct() public method

Construct repository object from aggregated repository and signal dispatcher

public __construct ( eZ\Publish\API\Repository\Repository $repository, SignalDispatcher $signalDispatcher )
$repository	eZ\Publish\API\Repository\Repository
$signalDispatcher	SignalDispatcher

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.

Deprecation: In 5.3.3, to be removed. Signals are emitted after transaction instead of being required to use this.

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

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.

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 ref.

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

getFieldTypeService() public method

Get FieldTypeService.

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

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

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

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 ) : mixed
$callback	Closure
return	mixed

Property Details

$contentService protected_oe property

Instance of content service.

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

$contentTypeService protected_oe property

Instance of content type service.

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

$fieldTypeService protected_oe property

Instance of field type service.

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

$ioService protected_oe property

Instance of IO service.

protected IOService,eZ\Publish\API\Repository $ioService
return	eZ\Publish\API\Repository\IOService

$languageService protected_oe property

Instance of language service.

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

$locationService protected_oe property

Instance of location service.

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

$objectStateService protected_oe property

Instance of object state service.

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

$repository protected_oe property

Repository Handler object.

protected Repository,eZ\Publish\API\Repository $repository
return	eZ\Publish\API\Repository\Repository

$roleService protected_oe property

Instance of role service.

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

$searchService protected_oe property

Instance of search service.

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

$sectionService protected_oe property

Instance of section service.

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

$signalDispatcher protected_oe property

SignalDispatcher.

protected SignalDispatcher,eZ\Publish\Core\SignalSlot $signalDispatcher
return	SignalDispatcher

$trashService protected_oe property

Instance of Trash service.

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

$urlAliasService protected_oe property

Instance of URL alias service.

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

$urlWildcardService protected_oe property

Instance of URL wildcard service.

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

$userService protected_oe property

Instance of user service.

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