TrashService::deleteTrashItem() - Code Metrics - Inspection of "EZP-28439: Related content is still displayed afte..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp-28439 ( b6528d )

unknown

created 2018-03-20 13:02 UTC

TrashService::deleteTrashItem() A

↳ Parent: TrashService

Complexity

Conditions	4
Paths	5

Size

Total Lines	19
Code Lines	12

Duplication

Lines	19
Ratio	100 %

Importance

Changes

Metric	Value
cc	4
eloc	12
nc	5
nop	1
dl	19
loc	19
rs	9.2
c	0
b	0
f	0

<?php

/**
 * File containing the eZ\Publish\Core\Repository\TrashService class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\Core\Repository;

use eZ\Publish\API\Repository\Exceptions\NotFoundException;
use eZ\Publish\API\Repository\TrashService as TrashServiceInterface;
use eZ\Publish\API\Repository\Repository as RepositoryInterface;
use eZ\Publish\API\Repository\Values\Content\ContentInfo;
use eZ\Publish\SPI\Persistence\Handler;
use eZ\Publish\API\Repository\Values\Content\Location;
use eZ\Publish\Core\Repository\Values\Content\TrashItem;
use eZ\Publish\API\Repository\Values\Content\TrashItem as APITrashItem;
use eZ\Publish\API\Repository\Values\Content\Query;
use eZ\Publish\SPI\Persistence\Content\Location\Trashed;
use eZ\Publish\Core\Base\Exceptions\InvalidArgumentValue;
use eZ\Publish\Core\Base\Exceptions\UnauthorizedException;
use eZ\Publish\API\Repository\Values\Content\Trash\SearchResult;
use eZ\Publish\API\Repository\Values\Content\Query\Criterion;
use eZ\Publish\API\Repository\Values\Content\Query\SortClause;
use DateTime;
use Exception;

/**
 * Trash service, used for managing trashed content.
 */
class TrashService implements TrashServiceInterface
{
    /**
     * @var \eZ\Publish\Core\Repository\Repository
     */
    protected $repository;

    /**
     * @var \eZ\Publish\SPI\Persistence\Handler
     */
    protected $persistenceHandler;

    /**
     * @var array
     */
    protected $settings;

    /**
     * @var \eZ\Publish\Core\Repository\Helper\NameSchemaService
     */
    protected $nameSchemaService;

    /**
     * Setups service with reference to repository object that created it & corresponding handler.
     *
     * @param \eZ\Publish\API\Repository\Repository $repository
     * @param \eZ\Publish\SPI\Persistence\Handler $handler
     * @param \eZ\Publish\Core\Repository\Helper\NameSchemaService $nameSchemaService
     * @param array $settings
     */
    public function __construct(
        RepositoryInterface $repository,
        Handler $handler,
        Helper\NameSchemaService $nameSchemaService,
        array $settings = array()
    ) {
        $this->repository = $repository;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        $this->persistenceHandler = $handler;
        $this->nameSchemaService = $nameSchemaService;
        // Union makes sure default settings are ignored if provided in argument
        $this->settings = $settings + array(
            //'defaultSetting' => array(),
        );
    }

    /**
     * Loads a trashed location object from its $id.
     *
     * Note that $id is identical to original location, which has been previously trashed
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the trashed location
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the location with the given id does not exist
     *
     * @param mixed $trashItemId
     *
     * @return \eZ\Publish\API\Repository\Values\Content\TrashItem
     */
    public function loadTrashItem($trashItemId)
    {
        if ($this->repository->hasAccess('content', 'restore') !== true) {

            throw new UnauthorizedException('content', 'restore');
        }

        $spiTrashItem = $this->persistenceHandler->trashHandler()->loadTrashItem($trashItemId);
        $trash = $this->buildDomainTrashItemObject($spiTrashItem);
        if (!$this->repository->canUser('content', 'read', $trash->getContentInfo())) {

            throw new UnauthorizedException('content', 'read');
        }

        return $trash;
    }

    /**
     * Sends $location and all its children to trash and returns the corresponding trash item.
     *
     * The current user may not have access to the returned trash item, check before using it.
     * Content is left untouched.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to trash the given location
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Location $location
     *
     * @return null|\eZ\Publish\API\Repository\Values\Content\TrashItem null if location was deleted, otherwise TrashItem
     */
    public function trash(Location $location)
    {
        if (!is_numeric($location->id)) {
            throw new InvalidArgumentValue('id', $location->id, 'Location');
        }

        if ($this->repository->canUser('content', 'manage_locations', $location->getContentInfo(), $location) !== true) {

            throw new UnauthorizedException('content', 'manage_locations');
        }

        $this->repository->beginTransaction();
        try {
            $spiTrashItem = $this->persistenceHandler->trashHandler()->trashSubtree($location->id);
            $this->persistenceHandler->urlAliasHandler()->locationDeleted($location->id);
            $this->repository->commit();
        } catch (Exception $e) {
            $this->repository->rollback();
            throw $e;
        }

        // Use sudo as we want a trash item regardless of user access to the trash.
        try {
            return isset($spiTrashItem)
                ? $this->repository->sudo(
                    function () use ($spiTrashItem) {
                        return $this->buildDomainTrashItemObject($spiTrashItem);
                    }
                )
                : null;
        } catch (Exception $e) {
            return null;
        }
    }

    /**
     * Recovers the $trashedLocation at its original place if possible.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to recover the trash item at the parent location location
     *
     * If $newParentLocation is provided, $trashedLocation will be restored under it.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\TrashItem $trashItem
     * @param \eZ\Publish\API\Repository\Values\Content\Location $newParentLocation
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Location the newly created or recovered location
     */
    public function recover(APITrashItem $trashItem, Location $newParentLocation = null)
    {
        if (!is_numeric($trashItem->id)) {
            throw new InvalidArgumentValue('id', $trashItem->id, 'TrashItem');
        }

        if ($newParentLocation === null && !is_numeric($trashItem->parentLocationId)) {
            throw new InvalidArgumentValue('parentLocationId', $trashItem->parentLocationId, 'TrashItem');
        }

        if ($newParentLocation !== null && !is_numeric($newParentLocation->id)) {
            throw new InvalidArgumentValue('parentLocationId', $newParentLocation->id, 'Location');
        }

        if ($this->repository->hasAccess('content', 'restore') !== true) {

            throw new UnauthorizedException('content', 'restore');
        }

        $this->repository->beginTransaction();
        try {
            $newParentLocationId = $newParentLocation ? $newParentLocation->id : $trashItem->parentLocationId;
            $newLocationId = $this->persistenceHandler->trashHandler()->recover(
                $trashItem->id,
                $newParentLocationId
            );

            $content = $this->repository->getContentService()->loadContent($trashItem->contentId);
            $urlAliasNames = $this->nameSchemaService->resolveUrlAliasSchema($content);

            // Publish URL aliases for recovered location
            foreach ($urlAliasNames as $languageCode => $name) {
                $this->persistenceHandler->urlAliasHandler()->publishUrlAliasForLocation(
                    $newLocationId,
                    $newParentLocationId,
                    $name,
                    $languageCode,
                    $content->contentInfo->alwaysAvailable
                );
            }

            $this->repository->commit();
        } catch (Exception $e) {
            $this->repository->rollback();
            throw $e;
        }

        return $this->repository->getLocationService()->loadLocation($newLocationId);
    }

    /**
     * Empties trash.
     *
     * All locations contained in the trash will be removed. Content objects will be removed
     * if all locations of the content are gone.
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to empty the trash
     */
    public function emptyTrash()
    {
        if ($this->repository->hasAccess('content', 'cleantrash') !== true) {

            throw new UnauthorizedException('content', 'cleantrash');
        }

        $this->repository->beginTransaction();
        try {
            // Persistence layer takes care of deleting content objects
            $this->persistenceHandler->trashHandler()->emptyTrash();
            $this->repository->commit();
        } catch (Exception $e) {
            $this->repository->rollback();
            throw $e;
        }
    }

    /**
     * Deletes a trash item.
     *
     * The corresponding content object will be removed
     *
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to delete this trash item
     *
     * @param \eZ\Publish\API\Repository\Values\Content\TrashItem $trashItem
     */
    public function deleteTrashItem(APITrashItem $trashItem)
    {
        if ($this->repository->hasAccess('content', 'cleantrash') !== true) {

            throw new UnauthorizedException('content', 'cleantrash');
        }

        if (!is_numeric($trashItem->id)) {
            throw new InvalidArgumentValue('id', $trashItem->id, 'TrashItem');
        }

        $this->repository->beginTransaction();
        try {
            $this->persistenceHandler->trashHandler()->deleteTrashItem($trashItem->id);
            $this->repository->commit();
        } catch (Exception $e) {
            $this->repository->rollback();
            throw $e;
        }
    }

    /**
     * Returns a collection of Trashed locations contained in the trash, which are readable by the current user.
     *
     * $query allows to filter/sort the elements to be contained in the collection.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query $query
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Trash\SearchResult
     */
    public function findTrashItems(Query $query)
    {
        if ($query->filter !== null && !$query->filter instanceof Criterion) {
            throw new InvalidArgumentValue('query->filter', $query->filter, 'Query');
        }

        if ($query->sortClauses !== null) {
            if (!is_array($query->sortClauses)) {
                throw new InvalidArgumentValue('query->sortClauses', $query->sortClauses, 'Query');
            }

            foreach ($query->sortClauses as $sortClause) {
                if (!$sortClause instanceof SortClause) {
                    throw new InvalidArgumentValue('query->sortClauses', 'only instances of SortClause class are allowed');
                }
            }
        }

        if ($query->offset !== null && !is_numeric($query->offset)) {

            throw new InvalidArgumentValue('query->offset', $query->offset, 'Query');
        }

        if ($query->limit !== null && !is_numeric($query->limit)) {

            throw new InvalidArgumentValue('query->limit', $query->limit, 'Query');
        }

        $spiTrashItems = $this->persistenceHandler->trashHandler()->findTrashItems(
            $query->filter,
            $query->offset !== null && $query->offset > 0 ? (int)$query->offset : 0,
            $query->limit !== null && $query->limit >= 1 ? (int)$query->limit : null,
            $query->sortClauses
        );

        $trashItems = array();
        foreach ($spiTrashItems as $spiTrashItem) {
            try {
                $trashItems[] = $this->buildDomainTrashItemObject($spiTrashItem);
            } catch (UnauthorizedException $e) {
                // Do nothing, thus exclude items the current user doesn't have read access to.
            }
        }

        $searchResult = new SearchResult();
        $searchResult->totalCount = $searchResult->count = count($trashItems);

        $searchResult->items = $trashItems;

        return $searchResult;
    }

    /**
     * Builds the domain TrashItem object from provided persistence trash item.
     *
     * @param \eZ\Publish\SPI\Persistence\Content\Location\Trashed $spiTrashItem
     *
     * @return \eZ\Publish\API\Repository\Values\Content\TrashItem
     */
    protected function buildDomainTrashItemObject(Trashed $spiTrashItem)
    {
        return new TrashItem(
            array(
                'contentInfo' => $this->repository->getContentService()->loadContentInfo($spiTrashItem->contentId),
                'id' => $spiTrashItem->id,
                'priority' => $spiTrashItem->priority,
                'hidden' => $spiTrashItem->hidden,
                'invisible' => $spiTrashItem->invisible,
                'remoteId' => $spiTrashItem->remoteId,
                'parentLocationId' => $spiTrashItem->parentId,
                'pathString' => $spiTrashItem->pathString,
                'depth' => $spiTrashItem->depth,
                'sortField' => $spiTrashItem->sortField,
                'sortOrder' => $spiTrashItem->sortOrder,
            )
        );
    }

    /**
     * @param int $timestamp
     *
     * @return \DateTime
     */
    protected function getDateTime($timestamp)
    {
        $dateTime = new DateTime();
        $dateTime->setTimestamp($timestamp);

        return $dateTime;
    }

    /**
     * Checks if Content is in trash when we can't rely only on locationId (ie. because ContentId is all we have,
     * and Content in trash is not part of a tree anymore, so does not have mainLocationId.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return bool
     */
    public function isContentInTrash($contentId)
    {
        $result = $this->repository->sudo(
            function () use ($contentId) {
                return $this->persistenceHandler->trashHandler()->loadTrashItemsByContentId($contentId);
            }
        );

        return !empty($result);
    }
}


1		<?php
2
3		/**
4		* File containing the eZ\Publish\Core\Repository\TrashService class.
5		*
6		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7		* @license For full copyright and license information view LICENSE file distributed with this source code.
8		*/
9		namespace eZ\Publish\Core\Repository;
10
11		use eZ\Publish\API\Repository\Exceptions\NotFoundException;
12		use eZ\Publish\API\Repository\TrashService as TrashServiceInterface;
13		use eZ\Publish\API\Repository\Repository as RepositoryInterface;
14		use eZ\Publish\API\Repository\Values\Content\ContentInfo;
15		use eZ\Publish\SPI\Persistence\Handler;
16		use eZ\Publish\API\Repository\Values\Content\Location;
17		use eZ\Publish\Core\Repository\Values\Content\TrashItem;
18		use eZ\Publish\API\Repository\Values\Content\TrashItem as APITrashItem;
19		use eZ\Publish\API\Repository\Values\Content\Query;
20		use eZ\Publish\SPI\Persistence\Content\Location\Trashed;
21		use eZ\Publish\Core\Base\Exceptions\InvalidArgumentValue;
22		use eZ\Publish\Core\Base\Exceptions\UnauthorizedException;
23		use eZ\Publish\API\Repository\Values\Content\Trash\SearchResult;
24		use eZ\Publish\API\Repository\Values\Content\Query\Criterion;
25		use eZ\Publish\API\Repository\Values\Content\Query\SortClause;
26		use DateTime;
27		use Exception;
28
29		/**
30		* Trash service, used for managing trashed content.
31		*/
32		class TrashService implements TrashServiceInterface
33		{
34		/**
35		* @var \eZ\Publish\Core\Repository\Repository
36		*/
37		protected $repository;
38
39		/**
40		* @var \eZ\Publish\SPI\Persistence\Handler
41		*/
42		protected $persistenceHandler;
43
44		/**
45		* @var array
46		*/
47		protected $settings;
48
49		/**
50		* @var \eZ\Publish\Core\Repository\Helper\NameSchemaService
51		*/
52		protected $nameSchemaService;
53
54		/**
55		* Setups service with reference to repository object that created it & corresponding handler.
56		*
57		* @param \eZ\Publish\API\Repository\Repository $repository
58		* @param \eZ\Publish\SPI\Persistence\Handler $handler
59		* @param \eZ\Publish\Core\Repository\Helper\NameSchemaService $nameSchemaService
60		* @param array $settings
61		*/
62		public function __construct(
63		RepositoryInterface $repository,
64		Handler $handler,
65		Helper\NameSchemaService $nameSchemaService,
66		array $settings = array()
67		) {
68		$this->repository = $repository;
		0 ignored issues – show Documentation Bug introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report `$repository` is of type `object<eZ\Publish\API\Repository\Repository>`, but the property `$repository` was declared to be of type `object<eZ\Publish\Core\Repository\Repository>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
69		$this->persistenceHandler = $handler;
70		$this->nameSchemaService = $nameSchemaService;
71		// Union makes sure default settings are ignored if provided in argument
72		$this->settings = $settings + array(
73		//'defaultSetting' => array(),
74		);
75		}
76
77		/**
78		* Loads a trashed location object from its $id.
79		*
80		* Note that $id is identical to original location, which has been previously trashed
81		*
82		* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the trashed location
83		* @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the location with the given id does not exist
84		*
85		* @param mixed $trashItemId
86		*
87		* @return \eZ\Publish\API\Repository\Values\Content\TrashItem
88		*/
89		public function loadTrashItem($trashItemId)
90		{
91		if ($this->repository->hasAccess('content', 'restore') !== true) {
		0 ignored issues – show Deprecated Code introduced 2017-11-08 15:04 UTC by Report Bug Copy Issue Report The method `eZ\Publish\Core\Repository\Repository::hasAccess()` has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::hasAccess() instead. Check if user has access to a given module / function. Low level function, use canUser instead if you have objects to check against. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
92		throw new UnauthorizedException('content', 'restore');
93		}
94
95		$spiTrashItem = $this->persistenceHandler->trashHandler()->loadTrashItem($trashItemId);
96		$trash = $this->buildDomainTrashItemObject($spiTrashItem);
97		if (!$this->repository->canUser('content', 'read', $trash->getContentInfo())) {
		0 ignored issues – show Deprecated Code introduced 2017-11-08 15:04 UTC by Report Bug Copy Issue Report The method `eZ\Publish\Core\Repository\Repository::canUser()` has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given objects. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
98		throw new UnauthorizedException('content', 'read');
99		}
100
101		return $trash;
102		}
103
104		/**
105		* Sends $location and all its children to trash and returns the corresponding trash item.
106		*
107		* The current user may not have access to the returned trash item, check before using it.
108		* Content is left untouched.
109		*
110		* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to trash the given location
111		*
112		* @param \eZ\Publish\API\Repository\Values\Content\Location $location
113		*
114		* @return null\|\eZ\Publish\API\Repository\Values\Content\TrashItem null if location was deleted, otherwise TrashItem
115		*/
116		public function trash(Location $location)
117		{
118		if (!is_numeric($location->id)) {
119		throw new InvalidArgumentValue('id', $location->id, 'Location');
120		}
121
122		if ($this->repository->canUser('content', 'manage_locations', $location->getContentInfo(), $location) !== true) {
		0 ignored issues – show Deprecated Code introduced 2017-11-08 15:04 UTC by Report Bug Copy Issue Report The method `eZ\Publish\Core\Repository\Repository::canUser()` has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given objects. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
123		throw new UnauthorizedException('content', 'manage_locations');
124		}
125
126		$this->repository->beginTransaction();
127		try {
128		$spiTrashItem = $this->persistenceHandler->trashHandler()->trashSubtree($location->id);
129		$this->persistenceHandler->urlAliasHandler()->locationDeleted($location->id);
130		$this->repository->commit();
131		} catch (Exception $e) {
132		$this->repository->rollback();
133		throw $e;
134		}
135
136		// Use sudo as we want a trash item regardless of user access to the trash.
137		try {
138		return isset($spiTrashItem)
139		? $this->repository->sudo(
140		function () use ($spiTrashItem) {
141		return $this->buildDomainTrashItemObject($spiTrashItem);
142		}
143		)
144		: null;
145		} catch (Exception $e) {
146		return null;
147		}
148		}
149
150		/**
151		* Recovers the $trashedLocation at its original place if possible.
152		*
153		* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to recover the trash item at the parent location location
154		*
155		* If $newParentLocation is provided, $trashedLocation will be restored under it.
156		*
157		* @param \eZ\Publish\API\Repository\Values\Content\TrashItem $trashItem
158		* @param \eZ\Publish\API\Repository\Values\Content\Location $newParentLocation
159		*
160		* @return \eZ\Publish\API\Repository\Values\Content\Location the newly created or recovered location
161		*/
162		public function recover(APITrashItem $trashItem, Location $newParentLocation = null)
163		{
164		if (!is_numeric($trashItem->id)) {
165		throw new InvalidArgumentValue('id', $trashItem->id, 'TrashItem');
166		}
167
168		if ($newParentLocation === null && !is_numeric($trashItem->parentLocationId)) {
169		throw new InvalidArgumentValue('parentLocationId', $trashItem->parentLocationId, 'TrashItem');
170		}
171
172		if ($newParentLocation !== null && !is_numeric($newParentLocation->id)) {
173		throw new InvalidArgumentValue('parentLocationId', $newParentLocation->id, 'Location');
174		}
175
176		if ($this->repository->hasAccess('content', 'restore') !== true) {
		0 ignored issues – show Deprecated Code introduced 2017-11-08 15:04 UTC by Report Bug Copy Issue Report The method `eZ\Publish\Core\Repository\Repository::hasAccess()` has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::hasAccess() instead. Check if user has access to a given module / function. Low level function, use canUser instead if you have objects to check against. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
177		throw new UnauthorizedException('content', 'restore');
178		}
179
180		$this->repository->beginTransaction();
181		try {
182		$newParentLocationId = $newParentLocation ? $newParentLocation->id : $trashItem->parentLocationId;
183		$newLocationId = $this->persistenceHandler->trashHandler()->recover(
184		$trashItem->id,
185		$newParentLocationId
186		);
187
188		$content = $this->repository->getContentService()->loadContent($trashItem->contentId);
189		$urlAliasNames = $this->nameSchemaService->resolveUrlAliasSchema($content);
190
191		// Publish URL aliases for recovered location
192		foreach ($urlAliasNames as $languageCode => $name) {
193		$this->persistenceHandler->urlAliasHandler()->publishUrlAliasForLocation(
194		$newLocationId,
195		$newParentLocationId,
196		$name,
197		$languageCode,
198		$content->contentInfo->alwaysAvailable
199		);
200		}
201
202		$this->repository->commit();
203		} catch (Exception $e) {
204		$this->repository->rollback();
205		throw $e;
206		}
207
208		return $this->repository->getLocationService()->loadLocation($newLocationId);
209		}
210
211		/**
212		* Empties trash.
213		*
214		* All locations contained in the trash will be removed. Content objects will be removed
215		* if all locations of the content are gone.
216		*
217		* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to empty the trash
218		*/
219	View Code Duplication	public function emptyTrash()
220		{
221		if ($this->repository->hasAccess('content', 'cleantrash') !== true) {
		0 ignored issues – show Deprecated Code introduced 2017-11-08 15:04 UTC by Report Bug Copy Issue Report The method `eZ\Publish\Core\Repository\Repository::hasAccess()` has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::hasAccess() instead. Check if user has access to a given module / function. Low level function, use canUser instead if you have objects to check against. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
222		throw new UnauthorizedException('content', 'cleantrash');
223		}
224
225		$this->repository->beginTransaction();
226		try {
227		// Persistence layer takes care of deleting content objects
228		$this->persistenceHandler->trashHandler()->emptyTrash();
229		$this->repository->commit();
230		} catch (Exception $e) {
231		$this->repository->rollback();
232		throw $e;
233		}
234		}
235
236		/**
237		* Deletes a trash item.
238		*
239		* The corresponding content object will be removed
240		*
241		* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to delete this trash item
242		*
243		* @param \eZ\Publish\API\Repository\Values\Content\TrashItem $trashItem
244		*/
245	View Code Duplication	public function deleteTrashItem(APITrashItem $trashItem)
246		{
247		if ($this->repository->hasAccess('content', 'cleantrash') !== true) {
		0 ignored issues – show Deprecated Code introduced 2017-11-08 15:04 UTC by Report Bug Copy Issue Report The method `eZ\Publish\Core\Repository\Repository::hasAccess()` has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::hasAccess() instead. Check if user has access to a given module / function. Low level function, use canUser instead if you have objects to check against. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
248		throw new UnauthorizedException('content', 'cleantrash');
249		}
250
251		if (!is_numeric($trashItem->id)) {
252		throw new InvalidArgumentValue('id', $trashItem->id, 'TrashItem');
253		}
254
255		$this->repository->beginTransaction();
256		try {
257		$this->persistenceHandler->trashHandler()->deleteTrashItem($trashItem->id);
258		$this->repository->commit();
259		} catch (Exception $e) {
260		$this->repository->rollback();
261		throw $e;
262		}
263		}
264
265		/**
266		* Returns a collection of Trashed locations contained in the trash, which are readable by the current user.
267		*
268		* $query allows to filter/sort the elements to be contained in the collection.
269		*
270		* @param \eZ\Publish\API\Repository\Values\Content\Query $query
271		*
272		* @return \eZ\Publish\API\Repository\Values\Content\Trash\SearchResult
273		*/
274		public function findTrashItems(Query $query)
275		{
276		if ($query->filter !== null && !$query->filter instanceof Criterion) {
277		throw new InvalidArgumentValue('query->filter', $query->filter, 'Query');
278		}
279
280		if ($query->sortClauses !== null) {
281		if (!is_array($query->sortClauses)) {
282		throw new InvalidArgumentValue('query->sortClauses', $query->sortClauses, 'Query');
283		}
284
285		foreach ($query->sortClauses as $sortClause) {
286		if (!$sortClause instanceof SortClause) {
287		throw new InvalidArgumentValue('query->sortClauses', 'only instances of SortClause class are allowed');
288		}
289		}
290		}
291
292	View Code Duplication	if ($query->offset !== null && !is_numeric($query->offset)) {
		0 ignored issues – show Duplication introduced 2017-12-14 17:59 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
293		throw new InvalidArgumentValue('query->offset', $query->offset, 'Query');
294		}
295
296	View Code Duplication	if ($query->limit !== null && !is_numeric($query->limit)) {
		0 ignored issues – show Duplication introduced 2017-12-14 17:59 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
297		throw new InvalidArgumentValue('query->limit', $query->limit, 'Query');
298		}
299
300		$spiTrashItems = $this->persistenceHandler->trashHandler()->findTrashItems(
301		$query->filter,
302		$query->offset !== null && $query->offset > 0 ? (int)$query->offset : 0,
303		$query->limit !== null && $query->limit >= 1 ? (int)$query->limit : null,
304		$query->sortClauses
305		);
306
307		$trashItems = array();
308		foreach ($spiTrashItems as $spiTrashItem) {
309		try {
310		$trashItems[] = $this->buildDomainTrashItemObject($spiTrashItem);
311		} catch (UnauthorizedException $e) {
312		// Do nothing, thus exclude items the current user doesn't have read access to.
313		}
314		}
315
316		$searchResult = new SearchResult();
317		$searchResult->totalCount = $searchResult->count = count($trashItems);
		0 ignored issues – show Deprecated Code introduced 2017-12-13 22:53 UTC by Report Bug Copy Issue Report The property `eZ\Publish\API\Repositor...sh\SearchResult::$count` has been deprecated with message: Property is here purely for BC with 5.x/6.x. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
318		$searchResult->items = $trashItems;
319
320		return $searchResult;
321		}
322
323		/**
324		* Builds the domain TrashItem object from provided persistence trash item.
325		*
326		* @param \eZ\Publish\SPI\Persistence\Content\Location\Trashed $spiTrashItem
327		*
328		* @return \eZ\Publish\API\Repository\Values\Content\TrashItem
329		*/
330	View Code Duplication	protected function buildDomainTrashItemObject(Trashed $spiTrashItem)
331		{
332		return new TrashItem(
333		array(
334		'contentInfo' => $this->repository->getContentService()->loadContentInfo($spiTrashItem->contentId),
335		'id' => $spiTrashItem->id,
336		'priority' => $spiTrashItem->priority,
337		'hidden' => $spiTrashItem->hidden,
338		'invisible' => $spiTrashItem->invisible,
339		'remoteId' => $spiTrashItem->remoteId,
340		'parentLocationId' => $spiTrashItem->parentId,
341		'pathString' => $spiTrashItem->pathString,
342		'depth' => $spiTrashItem->depth,
343		'sortField' => $spiTrashItem->sortField,
344		'sortOrder' => $spiTrashItem->sortOrder,
345		)
346		);
347		}
348
349		/**
350		* @param int $timestamp
351		*
352		* @return \DateTime
353		*/
354		protected function getDateTime($timestamp)
355		{
356		$dateTime = new DateTime();
357		$dateTime->setTimestamp($timestamp);
358
359		return $dateTime;
360		}
361
362		/**
363		* Checks if Content is in trash when we can't rely only on locationId (ie. because ContentId is all we have,
364		* and Content in trash is not part of a tree anymore, so does not have mainLocationId.
365		*
366		* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
		0 ignored issues – show Bug introduced 2018-03-20 13:21 UTC by Report Bug Copy Issue Report There is no parameter named `$contentInfo`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
367		*
368		* @return bool
369		*/
370		public function isContentInTrash($contentId)
371		{
372		$result = $this->repository->sudo(
373		function () use ($contentId) {
374		return $this->persistenceHandler->trashHandler()->loadTrashItemsByContentId($contentId);
375		}
376		);
377
378		return !empty($result);
379		}
380		}
381

ezsystems / ezpublish-kernel

Push — ezp-28439 ( b6528d )

TrashService::deleteTrashItem() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like