eZPublishCommunityProject  2013.9
eZ\Publish\Core\REST\Server\Controller\ObjectState Class Reference

ObjectState controller. More...

+ Inheritance diagram for eZ\Publish\Core\REST\Server\Controller\ObjectState:
+ Collaboration diagram for eZ\Publish\Core\REST\Server\Controller\ObjectState:

Public Member Functions

 __construct (ObjectStateService $objectStateService, ContentService $contentService)
 Construct controller. More...
 
 createObjectState ($objectStateGroupId)
 Creates a new object state. More...
 
 createObjectStateGroup ()
 Creates a new object state group. More...
 
 deleteObjectState ($objectStateId)
 The given object state is deleted. More...
 
 deleteObjectStateGroup ($objectStateGroupId)
 The given object state group including the object states is deleted. More...
 
 getObjectStatesForContent ($contentId)
 Returns the object states of content. More...
 
 loadObjectState ($objectStateGroupId, $objectStateId)
 Loads an object state. More...
 
 loadObjectStateGroup ($objectStateGroupId)
 Loads an object state group. More...
 
 loadObjectStateGroups ()
 Returns a list of all object state groups. More...
 
 loadObjectStates ($objectStateGroupId)
 Returns a list of all object states of the given group. More...
 
 setObjectStatesForContent ($contentId)
 Updates object states of content An object state in the input overrides the state of the object state group. More...
 
 updateObjectState ($objectStateGroupId, $objectStateId)
 Updates an object state. More...
 
 updateObjectStateGroup ($objectStateGroupId)
 Updates an object state group. More...
 
- Public Member Functions inherited from eZ\Publish\Core\REST\Server\Controller
 setContainer (Container $container)
 
 setInputDispatcher (InputDispatcher $inputDispatcher)
 
 setRepository (Repository $repository)
 
 setRequest (Request $request=null)
 
 setRequestParser (RequestParser $requestParser)
 
 setRouter (RouterInterface $router)
 

Protected Attributes

 $contentService
 
 $objectStateService
 
- Protected Attributes inherited from eZ\Publish\Core\REST\Server\Controller
 $container
 
 $inputDispatcher
 
 $repository
 
 $request
 
 $requestParser
 
 $router
 

Additional Inherited Members

- Protected Member Functions inherited from eZ\Publish\Core\REST\Server\Controller
 getMediaType ()
 Extracts the requested media type from $request. More...
 

Detailed Description

ObjectState controller.

Constructor & Destructor Documentation

eZ\Publish\Core\REST\Server\Controller\ObjectState::__construct ( ObjectStateService  $objectStateService,
ContentService  $contentService 
)

Construct controller.

Parameters
\eZ\Publish\API\Repository\ObjectStateService$objectStateService
\eZ\Publish\API\Repository\ContentService$contentService

Member Function Documentation

eZ\Publish\Core\REST\Server\Controller\ObjectState::createObjectState (   $objectStateGroupId)

Creates a new object state.

Parameters
$objectStateGroupId
Exceptions
\eZ\Publish\Core\REST\Server\Exceptions\ForbiddenException
Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::createObjectStateGroup ( )

Creates a new object state group.

Exceptions
\eZ\Publish\Core\REST\Server\Exceptions\ForbiddenException
Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::deleteObjectState (   $objectStateId)

The given object state is deleted.

Parameters
$objectStateId
Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::deleteObjectStateGroup (   $objectStateGroupId)

The given object state group including the object states is deleted.

Parameters
$objectStateGroupId
Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::getObjectStatesForContent (   $contentId)

Returns the object states of content.

Parameters
$contentId
Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::loadObjectState (   $objectStateGroupId,
  $objectStateId 
)

Loads an object state.

Parameters
$objectStateGroupId
$objectStateId
Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::loadObjectStateGroup (   $objectStateGroupId)

Loads an object state group.

Parameters
$objectStateGroupId
Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::loadObjectStateGroups ( )

Returns a list of all object state groups.

Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::loadObjectStates (   $objectStateGroupId)

Returns a list of all object states of the given group.

Parameters
$objectStateGroupId
Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::setObjectStatesForContent (   $contentId)

Updates object states of content An object state in the input overrides the state of the object state group.

Parameters
$contentId
Exceptions
\eZ\Publish\Core\REST\Server\Exceptions\ForbiddenException
Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::updateObjectState (   $objectStateGroupId,
  $objectStateId 
)

Updates an object state.

Parameters
$objectStateGroupId
$objectStateId
Exceptions
\eZ\Publish\Core\REST\Server\Exceptions\ForbiddenException
Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::updateObjectStateGroup (   $objectStateGroupId)

Updates an object state group.

Parameters
$objectStateGroupId
Exceptions
\eZ\Publish\Core\REST\Server\Exceptions\ForbiddenException
Returns

Member Data Documentation

eZ\Publish\Core\REST\Server\Controller\ObjectState::$contentService
protected
eZ\Publish\Core\REST\Server\Controller\ObjectState::$objectStateService
protected

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