eZPublishCommunityProject  2012.12
eZ\Publish\Core\REST\Client\Repository Class Reference

REST Client Repository. More...

+ Inheritance diagram for eZ\Publish\Core\REST\Client\Repository:
+ Collaboration diagram for eZ\Publish\Core\REST\Client\Repository:

Public Member Functions

 __construct (HttpClient $client, Common\Input\Dispatcher $inputDispatcher, Common\Output\Visitor $outputVisitor, Common\UrlHandler $urlHandler, array $fieldTypes)
 Instantiates the REST Client repository. More...
 
 beginTransaction ()
 Begin transaction. More...
 
 canUser ($module, $function, ValueObject $object, ValueObject $target=null)
 Indicates if the current user is allowed to perform an action given by the function on the given objects. More...
 
 commit ()
 Commit transaction. More...
 
 getContentLanguageService ()
 Get Content Language Service. More...
 
 getContentService ()
 Get Content Service. More...
 
 getContentTypeService ()
 Get Content Type Service. More...
 
 getCurrentUser ()
 Get current user. More...
 
 getFieldTypeService ()
 Get FieldTypeService. More...
 
 getIOService ()
 Get IO Service. More...
 
 getLocationService ()
 Get Content Location Service. More...
 
 getObjectStateService ()
 Get ObjectStateService. More...
 
 getRoleService ()
 Get RoleService. More...
 
 getSearchService ()
 Get Search Service. More...
 
 getSectionService ()
 Get Content Section Service. More...
 
 getTrashService ()
 Get Content Trash service. More...
 
 getUrlAliasService ()
 Get URLAliasService. More...
 
 getURLWildcardService ()
 Get URLWildcardService. More...
 
 getUserService ()
 Get User Service. More...
 
 hasAccess ($module, $function, User $user=null)
 
 rollback ()
 Rollback transaction. More...
 
 setCurrentUser (User $user)
 Sets the current user to the given $user. More...
 
- Public Member Functions inherited from eZ\Publish\API\Repository\Repository
 getURLAliasService ()
 Get URLAliasService. More...
 

Private Attributes

 $client
 
 $contentService
 
 $contentTypeService
 
 $currentUser
 
 $fieldTypes
 
 $fieldTypeService
 
 $inputDispatcher
 
 $ioService
 
 $languageService
 
 $locationService
 
 $objectStateService
 
 $outputVisitor
 
 $roleService
 
 $sectionService
 
 $trashService
 
 $urlAliasService
 
 $urlHandler
 
 $userService
 
 $version
 

Detailed Description

Constructor & Destructor Documentation

eZ\Publish\Core\REST\Client\Repository::__construct ( HttpClient  $client,
Common\Input\Dispatcher  $inputDispatcher,
Common\Output\Visitor  $outputVisitor,
Common\UrlHandler  $urlHandler,
array  $fieldTypes 
)

Instantiates the REST Client repository.

Parameters
\eZ\Publish\Core\REST\Client\HttpClient$client
\eZ\Publish\Core\REST\Common\Input\Dispatcher$inputDispatcher
\eZ\Publish\Core\REST\Common\Output\Visitor$outputVisitor
\eZ\Publish\Core\REST\Common\UrlHandler$urlHandler
\eZ\Publish\SPI\FieldType\FieldType[]$fieldTypes

Member Function Documentation

eZ\Publish\Core\REST\Client\Repository::beginTransaction ( )

Begin transaction.

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

Implements eZ\Publish\API\Repository\Repository.

eZ\Publish\Core\REST\Client\Repository::canUser (   $module,
  $function,
ValueObject  $object,
ValueObject  $target = null 
)

Indicates if the current user is allowed to perform an action given by the function on the given objects.

Exceptions
\eZ\Publish\API\Repository\Exceptions\InvalidArgumentExceptionIf any of the arguments are invalid
\eZ\Publish\API\Repository\Exceptions\BadStateExceptionIf value of the LimitationValue is unsupported
Parameters
string$moduleThe module, aka controller identifier to check permissions on
string$functionThe function, aka the controller action to check permissions on
\eZ\Publish\API\Repository\Values\ValueObject$objectThe object to check if the user has access to
\eZ\Publish\API\Repository\Values\ValueObject$targetThe location, parent or "assignment" value object
Returns
boolean

Implements eZ\Publish\API\Repository\Repository.

eZ\Publish\Core\REST\Client\Repository::commit ( )

Commit transaction.

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

Exceptions
\RuntimeExceptionIf no transaction has been started

Implements eZ\Publish\API\Repository\Repository.

eZ\Publish\Core\REST\Client\Repository::getContentLanguageService ( )

Get Content Language Service.

Get service object to perform operations on Content language objects

Returns

Implements eZ\Publish\API\Repository\Repository.

eZ\Publish\Core\REST\Client\Repository::getContentService ( )

Get Content Service.

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

Returns

Implements eZ\Publish\API\Repository\Repository.

Referenced by eZ\Publish\Core\REST\Client\Repository\getContentLanguageService().

eZ\Publish\Core\REST\Client\Repository::getContentTypeService ( )

Get Content Type Service.

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

Returns

Implements eZ\Publish\API\Repository\Repository.

Referenced by eZ\Publish\Core\REST\Client\Repository\getContentService().

eZ\Publish\Core\REST\Client\Repository::getCurrentUser ( )

Get current user.

Returns

Implements eZ\Publish\API\Repository\Repository.

eZ\Publish\Core\REST\Client\Repository::getFieldTypeService ( )
eZ\Publish\Core\REST\Client\Repository::getIOService ( )

Get IO Service.

Get service object to perform operations on binary files

Returns

Implements eZ\Publish\API\Repository\Repository.

eZ\Publish\Core\REST\Client\Repository::getLocationService ( )

Get Content Location Service.

Get service object to perform operations on Location objects and subtrees

Returns

Implements eZ\Publish\API\Repository\Repository.

Referenced by eZ\Publish\Core\REST\Client\Repository\getTrashService().

eZ\Publish\Core\REST\Client\Repository::getObjectStateService ( )
eZ\Publish\Core\REST\Client\Repository::getRoleService ( )
eZ\Publish\Core\REST\Client\Repository::getSearchService ( )

Get Search Service.

Get search service that lets you find content objects

Returns

Implements eZ\Publish\API\Repository\Repository.

eZ\Publish\Core\REST\Client\Repository::getSectionService ( )

Get Content Section Service.

Get Section service that lets you manipulate section objects

Returns

Implements eZ\Publish\API\Repository\Repository.

eZ\Publish\Core\REST\Client\Repository::getTrashService ( )

Get Content Trash service.

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

Returns

Implements eZ\Publish\API\Repository\Repository.

eZ\Publish\Core\REST\Client\Repository::getUrlAliasService ( )

Get URLAliasService.

Returns
eZ\Publish\Core\REST\Client\Repository::getURLWildcardService ( )

Get URLWildcardService.

Returns

Implements eZ\Publish\API\Repository\Repository.

eZ\Publish\Core\REST\Client\Repository::getUserService ( )

Get User Service.

Get service object to perform operations on Users and UserGroup

Returns

Implements eZ\Publish\API\Repository\Repository.

Referenced by eZ\Publish\Core\REST\Client\Repository\getRoleService().

eZ\Publish\Core\REST\Client\Repository::hasAccess (   $module,
  $function,
User  $user = null 
)
Parameters
string$module
string$function
\eZ\Publish\API\Repository\Values\User\User$user
Returns
boolean|[] if limitations are on this function an array of limitations is returned

Implements eZ\Publish\API\Repository\Repository.

eZ\Publish\Core\REST\Client\Repository::rollback ( )

Rollback transaction.

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

Exceptions
\RuntimeExceptionIf no transaction has been started

Implements eZ\Publish\API\Repository\Repository.

eZ\Publish\Core\REST\Client\Repository::setCurrentUser ( User  $user)

Sets the current user to the given $user.

Parameters
\eZ\Publish\API\Repository\Values\User\User$user
Returns
void

Implements eZ\Publish\API\Repository\Repository.

Member Data Documentation

eZ\Publish\Core\REST\Client\Repository::$client
private
eZ\Publish\Core\REST\Client\Repository::$contentService
private
eZ\Publish\Core\REST\Client\Repository::$contentTypeService
private
eZ\Publish\Core\REST\Client\Repository::$currentUser
private
eZ\Publish\Core\REST\Client\Repository::$fieldTypes
private
eZ\Publish\Core\REST\Client\Repository::$fieldTypeService
private
eZ\Publish\Core\REST\Client\Repository::$inputDispatcher
private
eZ\Publish\Core\REST\Client\Repository::$ioService
private
eZ\Publish\Core\REST\Client\Repository::$languageService
private
eZ\Publish\Core\REST\Client\Repository::$locationService
private
eZ\Publish\Core\REST\Client\Repository::$objectStateService
private
eZ\Publish\Core\REST\Client\Repository::$outputVisitor
private
eZ\Publish\Core\REST\Client\Repository::$roleService
private
eZ\Publish\Core\REST\Client\Repository::$sectionService
private
eZ\Publish\Core\REST\Client\Repository::$trashService
private
eZ\Publish\Core\REST\Client\Repository::$urlAliasService
private
eZ\Publish\Core\REST\Client\Repository::$urlHandler
private
eZ\Publish\Core\REST\Client\Repository::$userService
private
eZ\Publish\Core\REST\Client\Repository::$version
private

The documentation for this class was generated from the following file: