PHP Class eZ\Publish\Core\Repository\TrashService

Inheritance: implements eZ\Publish\API\Repository\TrashService
Datei anzeigen Open project: ezsystems/ezpublish-kernel

Protected Properties

Property Type Description
$nameSchemaService eZ\Publish\Core\Repository\Helper\NameSchemaService
$persistenceHandler eZ\Publish\SPI\Persistence\Handler
$repository eZ\Publish\API\Repository\Repository
$settings array

Public Methods

Method Description
__construct ( eZ\Publish\API\Repository\Repository $repository, eZ\Publish\SPI\Persistence\Handler $handler, NameSchemaService $nameSchemaService, array $settings = [] ) Setups service with reference to repository object that created it & corresponding handler.
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.
trash ( eZ\Publish\API\Repository\Values\Content\Location $location ) : null | 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
buildDomainTrashItemObject ( eZ\Publish\SPI\Persistence\Content\Location\Trashed $spiTrashItem ) : eZ\Publish\API\Repository\Values\Content\TrashItem Builds the domain TrashItem object from provided persistence trash item.
getDateTime ( integer $timestamp ) : DateTime

Method Details

__construct() public method

Setups service with reference to repository object that created it & corresponding handler.
public __construct ( eZ\Publish\API\Repository\Repository $repository, eZ\Publish\SPI\Persistence\Handler $handler, NameSchemaService $nameSchemaService, array $settings = [] )
$repository eZ\Publish\API\Repository\Repository
$handler eZ\Publish\SPI\Persistence\Handler
$nameSchemaService eZ\Publish\Core\Repository\Helper\NameSchemaService
$settings array

buildDomainTrashItemObject() protected method

Builds the domain TrashItem object from provided persistence trash item.
protected buildDomainTrashItemObject ( eZ\Publish\SPI\Persistence\Content\Location\Trashed $spiTrashItem ) : eZ\Publish\API\Repository\Values\Content\TrashItem
$spiTrashItem eZ\Publish\SPI\Persistence\Content\Location\Trashed
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

getDateTime() protected method

protected getDateTime ( integer $timestamp ) : DateTime
$timestamp integer
return DateTime

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

trash() public method

Content is left untouched.
public trash ( eZ\Publish\API\Repository\Values\Content\Location $location ) : null | eZ\Publish\API\Repository\Values\Content\TrashItem
$location eZ\Publish\API\Repository\Values\Content\Location
return null | eZ\Publish\API\Repository\Values\Content\TrashItem null if location was deleted, otherwise TrashItem

Property Details

$nameSchemaService protected_oe property

protected NameSchemaService,eZ\Publish\Core\Repository\Helper $nameSchemaService
return eZ\Publish\Core\Repository\Helper\NameSchemaService

$persistenceHandler protected_oe property

protected Handler,eZ\Publish\SPI\Persistence $persistenceHandler
return eZ\Publish\SPI\Persistence\Handler

$repository protected_oe property

protected Repository,eZ\Publish\API\Repository $repository
return eZ\Publish\API\Repository\Repository

$settings protected_oe property

protected array $settings
return array