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

Trash controller. More...

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

Public Member Functions

 __construct (TrashService $trashService, LocationService $locationService)
 Construct controller. More...
 
 deleteTrashItem ($trashItemId)
 Deletes the given trash item. More...
 
 emptyTrash ()
 Empties the trash. More...
 
 loadTrashItem ($trashItemId)
 Returns the trash item given by id. More...
 
 loadTrashItems ()
 Returns a list of all trash items. More...
 
 restoreTrashItem ($trashItemId)
 Restores a trashItem. 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

 $locationService
 
 $trashService
 
- 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

Trash controller.

Constructor & Destructor Documentation

eZ\Publish\Core\REST\Server\Controller\Trash::__construct ( TrashService  $trashService,
LocationService  $locationService 
)

Construct controller.

Parameters
\eZ\Publish\API\Repository\TrashService$trashService
\eZ\Publish\API\Repository\LocationService$locationService

Member Function Documentation

eZ\Publish\Core\REST\Server\Controller\Trash::deleteTrashItem (   $trashItemId)

Deletes the given trash item.

Parameters
$trashItemId
Returns
eZ\Publish\Core\REST\Server\Controller\Trash::emptyTrash ( )

Empties the trash.

Returns
eZ\Publish\Core\REST\Server\Controller\Trash::loadTrashItem (   $trashItemId)

Returns the trash item given by id.

Parameters
$trashItemId
Returns
eZ\Publish\Core\REST\Server\Controller\Trash::loadTrashItems ( )

Returns a list of all trash items.

Returns
eZ\Publish\Core\REST\Server\Controller\Trash::restoreTrashItem (   $trashItemId)

Restores a trashItem.

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

Member Data Documentation

eZ\Publish\Core\REST\Server\Controller\Trash::$locationService
protected
eZ\Publish\Core\REST\Server\Controller\Trash::$trashService
protected

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