Class

eZ\Publish\Core\REST\Server\Controller\ObjectState

class ObjectState extends Controller

ObjectState controller.

Methods

setInputDispatcher(Dispatcher $inputDispatcher)

from Controller
setRouter(RouterInterface $router)

from Controller
setRepository(Repository $repository)

from Controller
setRequestParser(RequestParser $requestParser)

from Controller
__construct(ObjectStateService $objectStateService, ContentService $contentService)

Construct controller.

CreatedObjectStateGroup createObjectStateGroup(Request $request)

Creates a new object state group.

CreatedObjectState createObjectState($objectStateGroupId, Request $request)

Creates a new object state.

ObjectStateGroup loadObjectStateGroup($objectStateGroupId $objectStateGroupId)

Loads an object state group.

RestObjectState loadObjectState($objectStateGroupId $objectStateGroupId, $objectStateId $objectStateId)

Loads an object state.

ObjectStateGroupList loadObjectStateGroups()

Returns a list of all object state groups.

ObjectStateList loadObjectStates($objectStateGroupId $objectStateGroupId)

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

NoContent deleteObjectStateGroup($objectStateGroupId $objectStateGroupId)

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

NoContent deleteObjectState($objectStateId $objectStateId)

The given object state is deleted.

ObjectStateGroup updateObjectStateGroup($objectStateGroupId, Request $request)

Updates an object state group.

RestObjectState updateObjectState($objectStateGroupId, $objectStateId, Request $request)

Updates an object state.

ContentObjectStates getObjectStatesForContent($contentId $contentId)

Returns the object states of content.

ContentObjectStates setObjectStatesForContent($contentId, Request $request)

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

Details

in Controller at line 45
public setInputDispatcher(Dispatcher $inputDispatcher)

Parameters

Dispatcher $inputDispatcher

in Controller at line 50
public setRouter(RouterInterface $router)

Parameters

RouterInterface $router

in Controller at line 55
public setRepository(Repository $repository)

Parameters

Repository $repository

in Controller at line 60
public setRequestParser(RequestParser $requestParser)

Parameters

RequestParser $requestParser

at line 48
public __construct(ObjectStateService $objectStateService, ContentService $contentService)

Construct controller.

Parameters

ObjectStateService $objectStateService
ContentService $contentService

at line 61
public CreatedObjectStateGroup createObjectStateGroup(Request $request)

Creates a new object state group.

Parameters

Request $request

Return Value

CreatedObjectStateGroup

Exceptions

ForbiddenException

at line 92
public CreatedObjectState createObjectState($objectStateGroupId, Request $request)

Creates a new object state.

Parameters

$objectStateGroupId
Request $request

Return Value

CreatedObjectState

Exceptions

ForbiddenException

at line 127
public ObjectStateGroup loadObjectStateGroup($objectStateGroupId $objectStateGroupId)

Loads an object state group.

Parameters

$objectStateGroupId $objectStateGroupId

Return Value

ObjectStateGroup

at line 140
public RestObjectState loadObjectState($objectStateGroupId $objectStateGroupId, $objectStateId $objectStateId)

Loads an object state.

Parameters

$objectStateGroupId $objectStateGroupId
$objectStateId $objectStateId

Return Value

RestObjectState

at line 153
public ObjectStateGroupList loadObjectStateGroups()

Returns a list of all object state groups.

Return Value

ObjectStateGroupList

at line 167
public ObjectStateList loadObjectStates($objectStateGroupId $objectStateGroupId)

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

Parameters

$objectStateGroupId $objectStateGroupId

Return Value

ObjectStateList

at line 184
public NoContent deleteObjectStateGroup($objectStateGroupId $objectStateGroupId)

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

Parameters

$objectStateGroupId $objectStateGroupId

Return Value

NoContent

at line 200
public NoContent deleteObjectState($objectStateId $objectStateId)

The given object state is deleted.

Parameters

$objectStateId $objectStateId

Return Value

NoContent

at line 218
public ObjectStateGroup updateObjectStateGroup($objectStateGroupId, Request $request)

Updates an object state group.

Parameters

$objectStateGroupId
Request $request

Return Value

ObjectStateGroup

Exceptions

ForbiddenException

at line 248
public RestObjectState updateObjectState($objectStateGroupId, $objectStateId, Request $request)

Updates an object state.

Parameters

$objectStateGroupId
$objectStateId
Request $request

Return Value

RestObjectState

Exceptions

ForbiddenException

at line 275
public ContentObjectStates getObjectStatesForContent($contentId $contentId)

Returns the object states of content.

Parameters

$contentId $contentId

Return Value

ContentObjectStates

at line 304
public ContentObjectStates setObjectStatesForContent($contentId, Request $request)

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

Parameters

$contentId
Request $request

Return Value

ContentObjectStates

Exceptions

ForbiddenException