PHP Class eZ\Publish\Core\REST\Client\Repository

See also: eZ\Publish\API\Repository\Repository

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

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

Public Methods

Method	Description
__construct ( eZ\Publish\Core\REST\Client\HttpClient $client, Dispatcher $inputDispatcher, Visitor $outputVisitor, eZ\Publish\Core\REST\Common\RequestParser $requestParser, array $fieldTypes )	Instantiates the REST Client repository.
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.
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.
getIOService ( ) : eZ\Publish\API\Repository\IOService	Get IO Service.
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 Search Service.
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 \| eZ\Publish\API\Repository\Values\User\Limitation[]
rollback ( )	Rollback transaction.
setCurrentUser ( eZ\Publish\API\Repository\Values\User\UserReference $user ) : void

Method Details

__construct() public method

Instantiates the REST Client repository.

public __construct ( eZ\Publish\Core\REST\Client\HttpClient $client, Dispatcher $inputDispatcher, Visitor $outputVisitor, eZ\Publish\Core\REST\Common\RequestParser $requestParser, array $fieldTypes )
$client	eZ\Publish\Core\REST\Client\HttpClient
$inputDispatcher	eZ\Publish\Core\REST\Common\Input\Dispatcher
$outputVisitor	eZ\Publish\Core\REST\Common\Output\Visitor
$requestParser	eZ\Publish\Core\REST\Common\RequestParser
$fieldTypes	array

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

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.

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

getIOService() public method

Get service object to perform operations on binary files

public getIOService ( ) : eZ\Publish\API\Repository\IOService
return	eZ\Publish\API\Repository\IOService

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 search service that lets you find content objects

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.

public hasAccess ( string $module, string $function, eZ\Publish\API\Repository\Values\User\UserReference $user = null ) : boolean \| eZ\Publish\API\Repository\Values\User\Limitation[]
$module	string
$function	string
$user	eZ\Publish\API\Repository\Values\User\UserReference
return	boolean \| eZ\Publish\API\Repository\Values\User\Limitation[]	if limitations are on this function an array of limitations is returned

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 ) : void
$user	eZ\Publish\API\Repository\Values\User\UserReference
return	void