LocationHandler::removeSubtree() - Code Metrics - Inspection of "[TMP][SPI] Add Content\Type\Handler->loadGroups()..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — sf_multi_get ( c68a81 )

by André

created 2017-02-22 21:36 UTC

LocationHandler::removeSubtree() A

↳ Parent: LocationHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	1
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0

<?php

/**
 * File containing the LocationHandler implementation.
 *
 * @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\Persistence\Cache;

use eZ\Publish\SPI\Persistence\Content\Location\Handler as LocationHandlerInterface;
use eZ\Publish\SPI\Persistence\Content\Location\CreateStruct;
use eZ\Publish\SPI\Persistence\Content\Location\UpdateStruct;
use eZ\Publish\SPI\Persistence\Content\Location;

/**
 * @see \eZ\Publish\SPI\Persistence\Content\Location\Handler
 */
class LocationHandler extends AbstractHandler implements LocationHandlerInterface
{
    /**
     * {@inheritdoc}
     */
    public function load($locationId)
    {
        $cacheItem = $this->cache->getItem("ez-location-${locationId}");
        if ($cacheItem->isHit()) {
            return $cacheItem->get();
        }

        $this->logger->logCall(__METHOD__, array('location' => $locationId));
        $location = $this->persistenceHandler->locationHandler()->load($locationId);

        $cacheItem->set($location);
        $cacheItem->tag($this->getCacheTags($location));
        $this->cache->save($cacheItem);

        return $location;
    }

    /**
     * {@inheritdoc}
     */
    public function loadSubtreeIds($locationId)
    {
        $cacheItem = $this->cache->getItem("ez-location-subtree-${locationId}");
        if ($cacheItem->isHit()) {
            return $cacheItem->get();
        }

        $this->logger->logCall(__METHOD__, array('location' => $locationId));
        $locationIds = $this->persistenceHandler->locationHandler()->loadSubtreeIds($locationId);

        $cacheItem->set($locationIds);
        $cacheTags = ['location-'.$locationId, 'location-path-'.$locationId];
        foreach ($locationIds as $locationId) {
            $cacheTags[] = 'location-'.$locationId;
            $cacheTags[] = 'location-path-'.$locationId;
        }
        $cacheItem->tag($cacheTags);
        $this->cache->save($cacheItem);

        return $locationIds;
    }

    /**
     * {@inheritdoc}
     */
    public function loadLocationsByContent($contentId, $rootLocationId = null)
    {
        if ($rootLocationId) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $cacheItem = $this->cache->getItem("ez-content-locations-${contentId}-root-${rootLocationId}");
            $cacheTags = ['content-'.$contentId, 'location-'.$rootLocationId, 'location-path-'.$rootLocationId];
        } else {
            $cacheItem = $this->cache->getItem("ez-content-locations-${contentId}");
            $cacheTags = ['content-'.$contentId];
        }

        if ($cacheItem->isHit()) {
            return $cacheItem->get();
        }

        $this->logger->logCall(__METHOD__, array('content' => $contentId, 'root' => $rootLocationId));
        $locations = $this->persistenceHandler->locationHandler()->loadLocationsByContent($contentId, $rootLocationId);

        $cacheItem->set($locations);
        foreach ($locations as $location) {
            $cacheTags = $this->getCacheTags($location, $cacheTags);
        }
        $cacheItem->tag($cacheTags);
        $this->cache->save($cacheItem);

        return $locations;
    }

    /**
     * {@inheritdoc}
     */
    public function loadParentLocationsForDraftContent($contentId)
    {
        $cacheItem = $this->cache->getItem("ez-content-locations-${contentId}-parentForDraft");
        if ($cacheItem->isHit()) {
            return $cacheItem->get();
        }

        $this->logger->logCall(__METHOD__, array('content' => $contentId));
        $locations = $this->persistenceHandler->locationHandler()->loadParentLocationsForDraftContent($contentId);

        $cacheItem->set($locations);
        $cacheTags = ['content-'.$contentId];
        foreach ($locations as $location) {
            $cacheTags = $this->getCacheTags($location, $cacheTags);
        }
        $cacheItem->tag($cacheTags);
        $this->cache->save($cacheItem);

        return $locations;
    }

    /**
     * {@inheritdoc}
     */
    public function loadByRemoteId($remoteId)
    {
        $cacheItem = $this->cache->getItem("ez-location-${remoteId}-by-remoteid");
        if ($cacheItem->isHit()) {
            return $cacheItem->get();
        }

        $this->logger->logCall(__METHOD__, array('location' => $remoteId));
        $location = $this->persistenceHandler->locationHandler()->loadByRemoteId($remoteId);

        $cacheItem->set($location);
        $cacheItem->tag($this->getCacheTags($location));
        $this->cache->save($cacheItem);

        return $location;
    }

    /**
     * {@inheritdoc}
     */
    public function copySubtree($sourceId, $destinationParentId)
    {
        $this->logger->logCall(__METHOD__, array('source' => $sourceId, 'destination' => $destinationParentId));

        return $this->persistenceHandler->locationHandler()->copySubtree($sourceId, $destinationParentId);
    }

    /**
     * {@inheritdoc}
     */
    public function move($sourceId, $destinationParentId)
    {
        $this->logger->logCall(__METHOD__, array('source' => $sourceId, 'destination' => $destinationParentId));
        $return = $this->persistenceHandler->locationHandler()->move($sourceId, $destinationParentId);

        $this->cache->invalidateTags(['location-path-'.$sourceId]);

        return $return;
    }

    /**
     * {@inheritdoc}
     */
    public function markSubtreeModified($locationId, $timestamp = null)
    {
        $this->logger->logCall(__METHOD__, array('location' => $locationId, 'time' => $timestamp));
        $this->persistenceHandler->locationHandler()->markSubtreeModified($locationId, $timestamp);

    }

    /**
     * {@inheritdoc}
     */
    public function hide($locationId)
    {
        $this->logger->logCall(__METHOD__, array('location' => $locationId));
        $return = $this->persistenceHandler->locationHandler()->hide($locationId);

        $this->cache->invalidateTags(['location-path-'.$locationId]);

        return $return;
    }

    /**
     * {@inheritdoc}
     */
    public function unHide($locationId)
    {
        $this->logger->logCall(__METHOD__, array('location' => $locationId));
        $return = $this->persistenceHandler->locationHandler()->unHide($locationId);

        $this->cache->invalidateTags(['location-path-'.$locationId]);

        return $return;
    }

    /**
     * {@inheritdoc}
     */
    public function swap($locationId1, $locationId2)
    {
        $this->logger->logCall(__METHOD__, array('location1' => $locationId1, 'location2' => $locationId2));
        $locationHandler = $this->persistenceHandler->locationHandler();

        $return = $locationHandler->swap($locationId1, $locationId2);

        $this->cache->invalidateTags(['location-'.$locationId1, 'location-'.$locationId2]);

        return $return;
    }

    /**
     * {@inheritdoc}
     */
    public function update(UpdateStruct $struct, $locationId)
    {
        $this->logger->logCall(__METHOD__, array('location' => $locationId, 'struct' => $struct));
        $this->persistenceHandler->locationHandler()->update($struct, $locationId);

        $this->cache->invalidateTags(['location-'.$locationId]);
    }

    /**
     * {@inheritdoc}
     */
    public function create(CreateStruct $locationStruct)
    {
        $this->logger->logCall(__METHOD__, array('struct' => $locationStruct));
        $location = $this->persistenceHandler->locationHandler()->create($locationStruct);

        // need to clear loadLocationsByContent and similar collections involving locations data
        // also need to clear content info on main location changes
        $this->cache->invalidateTags(['content-'.$locationStruct->contentId, 'role-assignment-group-list-'. $locationStruct->contentId]);

        return $location;
    }

    /**
     * {@inheritdoc}
     */
    public function removeSubtree($locationId)
    {
        $this->logger->logCall(__METHOD__, array('location' => $locationId));
        $return = $this->persistenceHandler->locationHandler()->removeSubtree($locationId);

        $this->cache->invalidateTags(['location-path-'.$locationId]);

        return $return;
    }

    /**
     * {@inheritdoc}
     */
    public function setSectionForSubtree($locationId, $sectionId)
    {
        $this->logger->logCall(__METHOD__, array('location' => $locationId, 'section' => $sectionId));
        $this->persistenceHandler->locationHandler()->setSectionForSubtree($locationId, $sectionId);

        $this->cache->invalidateTags(['location-path-'.$locationId]);
    }

    /**
     * {@inheritdoc}
     */
    public function changeMainLocation($contentId, $locationId)
    {
        $this->logger->logCall(__METHOD__, array('location' => $locationId, 'content' => $contentId));
        $this->persistenceHandler->locationHandler()->changeMainLocation($contentId, $locationId);

        $this->cache->invalidateTags(['content-'.$contentId]);
    }

    /**
     * Return relevant content and location tags so cache can be purged reliably.
     *
     * @param Location $location
     * @param array $tags Optional, can be used to specify additional tags.
     *
     * @return array
     */
    private function getCacheTags(Location $location, $tags = [])
    {
        // @todo use a different content tag here and reflect on in other handlers to be able to clear only content(?)
        $tags[] = 'content-'.$location->contentId;
        $tags[] = 'location-'.$location->id;
        foreach (explode('/', trim($location->pathString, '/')) as $pathId) {

            $tags[] = 'location-path-'.$pathId;
        }

        return $tags;
    }
}


1		<?php
2
3		/**
4		* File containing the LocationHandler implementation.
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\Persistence\Cache;
10
11		use eZ\Publish\SPI\Persistence\Content\Location\Handler as LocationHandlerInterface;
12		use eZ\Publish\SPI\Persistence\Content\Location\CreateStruct;
13		use eZ\Publish\SPI\Persistence\Content\Location\UpdateStruct;
14		use eZ\Publish\SPI\Persistence\Content\Location;
15
16		/**
17		* @see \eZ\Publish\SPI\Persistence\Content\Location\Handler
18		*/
19		class LocationHandler extends AbstractHandler implements LocationHandlerInterface
20		{
21		/**
22		* {@inheritdoc}
23		*/
24		public function load($locationId)
25		{
26		$cacheItem = $this->cache->getItem("ez-location-${locationId}");
27		if ($cacheItem->isHit()) {
28		return $cacheItem->get();
29		}
30
31		$this->logger->logCall(__METHOD__, array('location' => $locationId));
32		$location = $this->persistenceHandler->locationHandler()->load($locationId);
33
34		$cacheItem->set($location);
35		$cacheItem->tag($this->getCacheTags($location));
36		$this->cache->save($cacheItem);
37
38		return $location;
39		}
40
41		/**
42		* {@inheritdoc}
43		*/
44		public function loadSubtreeIds($locationId)
45		{
46		$cacheItem = $this->cache->getItem("ez-location-subtree-${locationId}");
47		if ($cacheItem->isHit()) {
48		return $cacheItem->get();
49		}
50
51		$this->logger->logCall(__METHOD__, array('location' => $locationId));
52		$locationIds = $this->persistenceHandler->locationHandler()->loadSubtreeIds($locationId);
53
54		$cacheItem->set($locationIds);
55		$cacheTags = ['location-'.$locationId, 'location-path-'.$locationId];
56		foreach ($locationIds as $locationId) {
57		$cacheTags[] = 'location-'.$locationId;
58		$cacheTags[] = 'location-path-'.$locationId;
59		}
60		$cacheItem->tag($cacheTags);
61		$this->cache->save($cacheItem);
62
63		return $locationIds;
64		}
65
66		/**
67		* {@inheritdoc}
68		*/
69		public function loadLocationsByContent($contentId, $rootLocationId = null)
70		{
71		if ($rootLocationId) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The expression `$rootLocationId` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
72		$cacheItem = $this->cache->getItem("ez-content-locations-${contentId}-root-${rootLocationId}");
73		$cacheTags = ['content-'.$contentId, 'location-'.$rootLocationId, 'location-path-'.$rootLocationId];
74		} else {
75		$cacheItem = $this->cache->getItem("ez-content-locations-${contentId}");
76		$cacheTags = ['content-'.$contentId];
77		}
78
79		if ($cacheItem->isHit()) {
80		return $cacheItem->get();
81		}
82
83		$this->logger->logCall(__METHOD__, array('content' => $contentId, 'root' => $rootLocationId));
84		$locations = $this->persistenceHandler->locationHandler()->loadLocationsByContent($contentId, $rootLocationId);
85
86		$cacheItem->set($locations);
87		foreach ($locations as $location) {
88		$cacheTags = $this->getCacheTags($location, $cacheTags);
89		}
90		$cacheItem->tag($cacheTags);
91		$this->cache->save($cacheItem);
92
93		return $locations;
94		}
95
96		/**
97		* {@inheritdoc}
98		*/
99		public function loadParentLocationsForDraftContent($contentId)
100		{
101		$cacheItem = $this->cache->getItem("ez-content-locations-${contentId}-parentForDraft");
102		if ($cacheItem->isHit()) {
103		return $cacheItem->get();
104		}
105
106		$this->logger->logCall(__METHOD__, array('content' => $contentId));
107		$locations = $this->persistenceHandler->locationHandler()->loadParentLocationsForDraftContent($contentId);
108
109		$cacheItem->set($locations);
110		$cacheTags = ['content-'.$contentId];
111		foreach ($locations as $location) {
112		$cacheTags = $this->getCacheTags($location, $cacheTags);
113		}
114		$cacheItem->tag($cacheTags);
115		$this->cache->save($cacheItem);
116
117		return $locations;
118		}
119
120		/**
121		* {@inheritdoc}
122		*/
123		public function loadByRemoteId($remoteId)
124		{
125		$cacheItem = $this->cache->getItem("ez-location-${remoteId}-by-remoteid");
126		if ($cacheItem->isHit()) {
127		return $cacheItem->get();
128		}
129
130		$this->logger->logCall(__METHOD__, array('location' => $remoteId));
131		$location = $this->persistenceHandler->locationHandler()->loadByRemoteId($remoteId);
132
133		$cacheItem->set($location);
134		$cacheItem->tag($this->getCacheTags($location));
135		$this->cache->save($cacheItem);
136
137		return $location;
138		}
139
140		/**
141		* {@inheritdoc}
142		*/
143		public function copySubtree($sourceId, $destinationParentId)
144		{
145		$this->logger->logCall(__METHOD__, array('source' => $sourceId, 'destination' => $destinationParentId));
146
147		return $this->persistenceHandler->locationHandler()->copySubtree($sourceId, $destinationParentId);
148		}
149
150		/**
151		* {@inheritdoc}
152		*/
153		public function move($sourceId, $destinationParentId)
154		{
155		$this->logger->logCall(__METHOD__, array('source' => $sourceId, 'destination' => $destinationParentId));
156		$return = $this->persistenceHandler->locationHandler()->move($sourceId, $destinationParentId);
157
158		$this->cache->invalidateTags(['location-path-'.$sourceId]);
159
160		return $return;
161		}
162
163		/**
164		* {@inheritdoc}
165		*/
166		public function markSubtreeModified($locationId, $timestamp = null)
167		{
168		$this->logger->logCall(__METHOD__, array('location' => $locationId, 'time' => $timestamp));
169		$this->persistenceHandler->locationHandler()->markSubtreeModified($locationId, $timestamp);
		0 ignored issues – show Deprecated Code introduced 2017-01-18 16:50 UTC by Report Bug Copy Issue Report The method `eZ\Publish\SPI\Persisten...::markSubtreeModified()` has been deprecated with message: As of 6.8, not been used by repository since 5.x. 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...
170		}
171
172		/**
173		* {@inheritdoc}
174		*/
175		public function hide($locationId)
176		{
177		$this->logger->logCall(__METHOD__, array('location' => $locationId));
178		$return = $this->persistenceHandler->locationHandler()->hide($locationId);
179
180		$this->cache->invalidateTags(['location-path-'.$locationId]);
181
182		return $return;
183		}
184
185		/**
186		* {@inheritdoc}
187		*/
188		public function unHide($locationId)
189		{
190		$this->logger->logCall(__METHOD__, array('location' => $locationId));
191		$return = $this->persistenceHandler->locationHandler()->unHide($locationId);
192
193		$this->cache->invalidateTags(['location-path-'.$locationId]);
194
195		return $return;
196		}
197
198		/**
199		* {@inheritdoc}
200		*/
201		public function swap($locationId1, $locationId2)
202		{
203		$this->logger->logCall(__METHOD__, array('location1' => $locationId1, 'location2' => $locationId2));
204		$locationHandler = $this->persistenceHandler->locationHandler();
205
206		$return = $locationHandler->swap($locationId1, $locationId2);
207
208		$this->cache->invalidateTags(['location-'.$locationId1, 'location-'.$locationId2]);
209
210		return $return;
211		}
212
213		/**
214		* {@inheritdoc}
215		*/
216		public function update(UpdateStruct $struct, $locationId)
217		{
218		$this->logger->logCall(__METHOD__, array('location' => $locationId, 'struct' => $struct));
219		$this->persistenceHandler->locationHandler()->update($struct, $locationId);
220
221		$this->cache->invalidateTags(['location-'.$locationId]);
222		}
223
224		/**
225		* {@inheritdoc}
226		*/
227	View Code Duplication	public function create(CreateStruct $locationStruct)
228		{
229		$this->logger->logCall(__METHOD__, array('struct' => $locationStruct));
230		$location = $this->persistenceHandler->locationHandler()->create($locationStruct);
231
232		// need to clear loadLocationsByContent and similar collections involving locations data
233		// also need to clear content info on main location changes
234		$this->cache->invalidateTags(['content-'.$locationStruct->contentId, 'role-assignment-group-list-'. $locationStruct->contentId]);
235
236		return $location;
237		}
238
239		/**
240		* {@inheritdoc}
241		*/
242		public function removeSubtree($locationId)
243		{
244		$this->logger->logCall(__METHOD__, array('location' => $locationId));
245		$return = $this->persistenceHandler->locationHandler()->removeSubtree($locationId);
246
247		$this->cache->invalidateTags(['location-path-'.$locationId]);
248
249		return $return;
250		}
251
252		/**
253		* {@inheritdoc}
254		*/
255		public function setSectionForSubtree($locationId, $sectionId)
256		{
257		$this->logger->logCall(__METHOD__, array('location' => $locationId, 'section' => $sectionId));
258		$this->persistenceHandler->locationHandler()->setSectionForSubtree($locationId, $sectionId);
259
260		$this->cache->invalidateTags(['location-path-'.$locationId]);
261		}
262
263		/**
264		* {@inheritdoc}
265		*/
266		public function changeMainLocation($contentId, $locationId)
267		{
268		$this->logger->logCall(__METHOD__, array('location' => $locationId, 'content' => $contentId));
269		$this->persistenceHandler->locationHandler()->changeMainLocation($contentId, $locationId);
270
271		$this->cache->invalidateTags(['content-'.$contentId]);
272		}
273
274		/**
275		* Return relevant content and location tags so cache can be purged reliably.
276		*
277		* @param Location $location
278		* @param array $tags Optional, can be used to specify additional tags.
279		*
280		* @return array
281		*/
282		private function getCacheTags(Location $location, $tags = [])
283		{
284		// @todo use a different content tag here and reflect on in other handlers to be able to clear only content(?)
285		$tags[] = 'content-'.$location->contentId;
286		$tags[] = 'location-'.$location->id;
287	View Code Duplication	foreach (explode('/', trim($location->pathString, '/')) as $pathId) {
		0 ignored issues – show Duplication introduced 2017-01-18 16:50 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...
288		$tags[] = 'location-path-'.$pathId;
289		}
290
291		return $tags;
292		}
293		}
294

ezsystems / ezpublish-kernel

Push — sf_multi_get ( c68a81 )

LocationHandler::removeSubtree() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like