PHP Class eZ\Publish\Core\REST\Client\TrashService

Inheritance: implements eZ\Publish\API\Repository\TrashService, implements eZ\Publish\Core\REST\Client\Sessionable
Show file Open project: ezsystems/ezpublish-kernel

Public Methods

Method Description
__construct ( LocationService $locationService, eZ\Publish\Core\REST\Client\HttpClient $client, Dispatcher $inputDispatcher, Visitor $outputVisitor, eZ\Publish\Core\REST\Common\RequestParser $requestParser )
deleteTrashItem ( eZ\Publish\API\Repository\Values\Content\TrashItem $trashItem ) Deletes a trash item.
emptyTrash ( ) Empties trash.
findTrashItems ( eZ\Publish\API\Repository\Values\Content\Query $query ) : eZ\Publish\API\Repository\Values\Content\SearchResult Returns a collection of Trashed locations contained in the trash.
loadTrashItem ( mixed $trashItemId ) : eZ\Publish\API\Repository\Values\Content\TrashItem Loads a trashed location object from its $id.
recover ( eZ\Publish\API\Repository\Values\Content\TrashItem $trashItem, eZ\Publish\API\Repository\Values\Content\Location $newParentLocation = null ) : eZ\Publish\API\Repository\Values\Content\Location Recovers the $trashedLocation at its original place if possible.
setSession ( mixed $id ) Set session ID.
trash ( eZ\Publish\API\Repository\Values\Content\Location $location ) : eZ\Publish\API\Repository\Values\Content\TrashItem Sends $location and all its children to trash and returns the corresponding trash item.

Protected Methods

Method Description
buildTrashItem ( eZ\Publish\API\Repository\Values\Content\Location $location ) : eZ\Publish\API\Repository\Values\Content\TrashItem Converts the Location value object to TrashItem value object.

Method Details

__construct() public method

public __construct ( LocationService $locationService, eZ\Publish\Core\REST\Client\HttpClient $client, Dispatcher $inputDispatcher, Visitor $outputVisitor, eZ\Publish\Core\REST\Common\RequestParser $requestParser )
$locationService LocationService
$client eZ\Publish\Core\REST\Client\HttpClient
$inputDispatcher eZ\Publish\Core\REST\Common\Input\Dispatcher
$outputVisitor eZ\Publish\Core\REST\Common\Output\Visitor
$requestParser eZ\Publish\Core\REST\Common\RequestParser

buildTrashItem() protected method

Converts the Location value object to TrashItem value object.
protected buildTrashItem ( eZ\Publish\API\Repository\Values\Content\Location $location ) : eZ\Publish\API\Repository\Values\Content\TrashItem
$location eZ\Publish\API\Repository\Values\Content\Location
return eZ\Publish\API\Repository\Values\Content\TrashItem

deleteTrashItem() public method

The corresponding content object will be removed
public deleteTrashItem ( eZ\Publish\API\Repository\Values\Content\TrashItem $trashItem )
$trashItem eZ\Publish\API\Repository\Values\Content\TrashItem

emptyTrash() public method

All locations contained in the trash will be removed. Content objects will be removed if all locations of the content are gone.
public emptyTrash ( )

findTrashItems() public method

$query allows to filter/sort the elements to be contained in the collection.
public findTrashItems ( eZ\Publish\API\Repository\Values\Content\Query $query ) : eZ\Publish\API\Repository\Values\Content\SearchResult
$query eZ\Publish\API\Repository\Values\Content\Query
return eZ\Publish\API\Repository\Values\Content\SearchResult

loadTrashItem() public method

Note that $id is identical to original location, which has been previously trashed
public loadTrashItem ( mixed $trashItemId ) : eZ\Publish\API\Repository\Values\Content\TrashItem
$trashItemId mixed
return eZ\Publish\API\Repository\Values\Content\TrashItem

recover() public method

Recovers the $trashedLocation at its original place if possible.
public recover ( eZ\Publish\API\Repository\Values\Content\TrashItem $trashItem, eZ\Publish\API\Repository\Values\Content\Location $newParentLocation = null ) : eZ\Publish\API\Repository\Values\Content\Location
$trashItem eZ\Publish\API\Repository\Values\Content\TrashItem
$newParentLocation eZ\Publish\API\Repository\Values\Content\Location
return eZ\Publish\API\Repository\Values\Content\Location the newly created or recovered location

setSession() public method

Only for testing
public setSession ( mixed $id )
$id mixed

trash() public method

Content is left untouched.
public trash ( eZ\Publish\API\Repository\Values\Content\Location $location ) : eZ\Publish\API\Repository\Values\Content\TrashItem
$location eZ\Publish\API\Repository\Values\Content\Location
return eZ\Publish\API\Repository\Values\Content\TrashItem