eZPublishCommunityProject  2013.4
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 ()
 Creates a new object state. More...
 
 createObjectStateGroup ()
 Creates a new object state group. More...
 
 deleteObjectState ()
 The given object state is deleted. More...
 
 deleteObjectStateGroup ()
 The given object state group including the object states is deleted. More...
 
 getObjectStatesForContent ()
 Returns the object states of content. More...
 
 loadObjectState ()
 Loads an object state. More...
 
 loadObjectStateGroup ()
 Loads an object state group. More...
 
 loadObjectStateGroups ()
 Returns a list of all object state groups. More...
 
 loadObjectStates ()
 Returns a list of all object states of the given group. More...
 
 setObjectStatesForContent ()
 Updates object states of content An object state in the input overrides the state of the object state group. More...
 
 updateObjectState ()
 Updates an object state. More...
 
 updateObjectStateGroup ()
 Updates an object state group. More...
 
- Public Member Functions inherited from eZ\Publish\Core\REST\Server\Controller
 setContainer (Container $container)
 
 setInputDispatcher (InputDispatcher $inputDispatcher)
 
 setRequest (HttpRequest $request)
 
 setUrlHandler (UrlHandler $urlHandler)
 

Protected Attributes

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

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 ( )

Creates a new object state.

Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::createObjectStateGroup ( )

Creates a new object state group.

Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::deleteObjectState ( )

The given object state is deleted.

Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::deleteObjectStateGroup ( )

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

Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::getObjectStatesForContent ( )

Returns the object states of content.

Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::loadObjectState ( )

Loads an object state.

Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::loadObjectStateGroup ( )

Loads an object state group.

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 ( )

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

Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::setObjectStatesForContent ( )

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

Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::updateObjectState ( )

Updates an object state.

Returns
eZ\Publish\Core\REST\Server\Controller\ObjectState::updateObjectStateGroup ( )

Updates an object state group.

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: