UrlAliasHandler::listGlobalURLAliases() - Code Metrics - Inspection of "Refactor: introduce internalPublishUrlAliasForLoca..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — EZP-26146-location-swap-urlali... ( 3d141e...44a3c1 )

unknown

created 2016-09-15 14:14 UTC

UrlAliasHandler::listGlobalURLAliases() A

↳ Parent: UrlAliasHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	3
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php

/**
 * File containing the UrlAlias Handler 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.
 *
 * @version //autogentag//
 */
namespace eZ\Publish\Core\Persistence\Cache;

use eZ\Publish\API\Repository\Exceptions\NotFoundException as APINotFoundException;
use eZ\Publish\Core\Base\Exceptions\NotFoundException;
use eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler as UrlAliasHandlerInterface;
use eZ\Publish\SPI\Persistence\Content\UrlAlias;

/**
 * @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler
 */
class UrlAliasHandler extends AbstractHandler implements UrlAliasHandlerInterface
{
    /**
     * Constant used for storing not found results for lookup().
     */
    const NOT_FOUND = 0;

    /**
     * @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::publishUrlAliasForLocation
     */
    public function publishUrlAliasForLocation(
        $locationId,
        $parentLocationId,
        $name,
        $languageCode,
        $alwaysAvailable = false,
        $updatePathIdentificationString = false
    ) {
        $this->logger->logCall(
            __METHOD__,
            array(
                'location' => $locationId,
                'parent' => $parentLocationId,
                'name' => $name,
                'language' => $languageCode,
                'alwaysAvailable' => $alwaysAvailable,
            )
        );
        $this->clearLocation($locationId);

        $this->persistenceHandler->urlAliasHandler()->publishUrlAliasForLocation(
            $locationId,
            $parentLocationId,
            $name,
            $languageCode,
            $alwaysAvailable,
            $updatePathIdentificationString
        );
    }

    /**
     * @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::createCustomUrlAlias
     */
    public function createCustomUrlAlias($locationId, $path, $forwarding = false, $languageCode = null, $alwaysAvailable = false)
    {
        $this->logger->logCall(
            __METHOD__,
            array(
                'location' => $locationId,
                '$path' => $path,
                '$forwarding' => $forwarding,
                'language' => $languageCode,
                'alwaysAvailable' => $alwaysAvailable,
            )
        );

        $urlAlias = $this->persistenceHandler->urlAliasHandler()->createCustomUrlAlias(
            $locationId,
            $path,
            $forwarding,
            $languageCode,
            $alwaysAvailable
        );

        $this->cache->getItem('urlAlias', $urlAlias->id)->set($urlAlias)->save();
        $cache = $this->cache->getItem('urlAlias', 'location', $urlAlias->destination, 'custom');
        $urlAliasIds = $cache->get();
        if ($cache->isMiss()) {
            $urlAliasIds = array();
        }

        $urlAliasIds[] = $urlAlias->id;
        $cache->set($urlAliasIds)->save();

        return $urlAlias;
    }

    /**
     * @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::createGlobalUrlAlias
     */
    public function createGlobalUrlAlias($resource, $path, $forwarding = false, $languageCode = null, $alwaysAvailable = false)
    {
        $this->logger->logCall(
            __METHOD__,
            array(
                'resource' => $resource,
                'path' => $path,
                'forwarding' => $forwarding,
                'language' => $languageCode,
                'alwaysAvailable' => $alwaysAvailable,
            )
        );

        $urlAlias = $this->persistenceHandler->urlAliasHandler()->createGlobalUrlAlias(
            $resource,
            $path,
            $forwarding,
            $languageCode,
            $alwaysAvailable
        );

        $this->cache->getItem('urlAlias', $urlAlias->id)->set($urlAlias)->save();

        return $urlAlias;
    }

    /**
     * @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::listGlobalURLAliases
     */
    public function listGlobalURLAliases($languageCode = null, $offset = 0, $limit = -1)
    {
        $this->logger->logCall(__METHOD__, array('language' => $languageCode, 'offset' => $offset, 'limit' => $limit));

        return $this->persistenceHandler->urlAliasHandler()->listGlobalURLAliases($languageCode, $offset, $limit);
    }

    /**
     * @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::listURLAliasesForLocation
     */
    public function listURLAliasesForLocation($locationId, $custom = false)
    {
        // Look for location to list of url alias id's cache
        if ($custom) {
            $cache = $this->cache->getItem('urlAlias', 'location', $locationId, 'custom');
        } else {
            $cache = $this->cache->getItem('urlAlias', 'location', $locationId);
        }
        $urlAliasIds = $cache->get();
        if ($cache->isMiss()) {
            $this->logger->logCall(__METHOD__, array('location' => $locationId, 'custom' => $custom));
            $urlAliases = $this->persistenceHandler->urlAliasHandler()->listURLAliasesForLocation($locationId, $custom);

            $urlAliasIds = array();
            foreach ($urlAliases as $urlAlias) {
                $urlAliasIds[] = $urlAlias->id;
            }

            $cache->set($urlAliasIds)->save();
        } else {
            // Reuse loadUrlAlias for the url alias object cache
            $urlAliases = array();
            foreach ($urlAliasIds as $urlAliasId) {
                $urlAliases[] = $this->loadUrlAlias($urlAliasId);
            }
        }

        return $urlAliases;
    }

    /**
     * @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::removeURLAliases
     */
    public function removeURLAliases(array $urlAliases)
    {
        $this->logger->logCall(__METHOD__, array('aliases' => $urlAliases));
        $return = $this->persistenceHandler->urlAliasHandler()->removeURLAliases($urlAliases);

        $this->cache->clear('urlAlias', 'url');//TIMBER! (no easy way to do reverse lookup of urls)
        foreach ($urlAliases as $urlAlias) {
            $this->cache->clear('urlAlias', $urlAlias->id);
            if ($urlAlias->type === UrlAlias::LOCATION) {
                $this->cache->clear('urlAlias', 'location', $urlAlias->destination);
            }
            if ($urlAlias->isCustom) {
                $this->cache->clear('urlAlias', 'location', $urlAlias->destination, 'custom');
            }
        }

        return $return;
    }

    /**
     * @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::lookup
     */
    public function lookup($url)
    {
        // Look for url to url alias id cache
        // Replace slashes by "|" to be sure not to mix cache key combinations in underlying lib.
        $cacheKey = $url ?: '/';
        $cache = $this->cache->getItem('urlAlias', 'url', $cacheKey);
        $urlAliasId = $cache->get();
        if ($cache->isMiss()) {
            // Also cache "not found" as this function is heavliy used and hance should be cached
            try {
                $this->logger->logCall(__METHOD__, array('url' => $url));
                $urlAlias = $this->persistenceHandler->urlAliasHandler()->lookup($url);
                $cache->set($urlAlias->id)->save();

                $urlAliasCache = $this->cache->getItem('urlAlias', $urlAlias->id);
                $urlAliasCache->set($urlAlias)->save();
            } catch (APINotFoundException $e) {
                $cache->set(self::NOT_FOUND)->save();
                throw $e;
            }
        } elseif ($urlAliasId === self::NOT_FOUND) {
            throw new NotFoundException('UrlAlias', $url);
        } else {
            $urlAlias = $this->loadUrlAlias($urlAliasId);
        }

        return $urlAlias;
    }

    /**
     * @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::loadUrlAlias
     */
    public function loadUrlAlias($id)
    {
        // Look for url alias cache
        $cache = $this->cache->getItem('urlAlias', $id);
        $urlAlias = $cache->get();
        if ($cache->isMiss()) {
            $this->logger->logCall(__METHOD__, array('alias' => $id));
            $urlAlias = $this->persistenceHandler->urlAliasHandler()->loadUrlAlias($id);
            $cache->set($urlAlias)->save();
        }

        return $urlAlias;
    }

    /**
     * @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::locationMoved
     */
    public function locationMoved($locationId, $oldParentId, $newParentId)
    {
        $this->logger->logCall(
            __METHOD__,
            array(
                'location' => $locationId,
                'oldParent' => $oldParentId,
                'newParent' => $newParentId,
            )
        );

        $return = $this->persistenceHandler->urlAliasHandler()->locationMoved($locationId, $oldParentId, $newParentId);
        $this->cache->clear('urlAlias', 'url');//TIMBER! (Will have to load url aliases for location to be able to clear specific entries)

        return $return;
    }

    /**
     * @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::locationCopied
     */
    public function locationCopied($locationId, $newLocationId, $newParentId)
    {
        $this->logger->logCall(
            __METHOD__,
            array(
                'oldLocation' => $locationId,
                'newLocation' => $newLocationId,
                'newParent' => $newParentId,
            )
        );

        $return = $this->persistenceHandler->urlAliasHandler()->locationCopied(
            $locationId,
            $newLocationId,
            $newParentId
        );
        $this->cache->clear('urlAlias', 'url'); // required due to caching not found aliases

        return $return;
    }

    /**
     * @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::locationDeleted
     */
    public function locationDeleted($locationId)
    {
        $this->logger->logCall(__METHOD__, array('location' => $locationId));
        $return = $this->persistenceHandler->urlAliasHandler()->locationDeleted($locationId);

        $this->clearLocation($locationId);

        return $return;
    }

    /**
     * @param $locationId
     */
    protected function clearLocation($locationId)
    {
        $locationCache = $this->cache->getItem('urlAlias', 'location', $locationId);

        if ($locationCache->isMiss()) {
            // we need to clear all if we don't have location id in cache
            $this->cache->clear('urlAlias');
        } else {
            $urlAliasIds = $locationCache->get();
            foreach ((array) $urlAliasIds as $urlAliasId) {
                $this->cache->clear('urlAlias', $urlAliasId);
            }
            $this->cache->clear('urlAlias', 'url');
            $locationCache->clear();
        }
    }

    /**
     * @see \eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::swap
     */
    public function locationSwapped($location1ParentId, $location1Id, $location2ParentId, $location2Id)
    {
        $this->logger->logCall(
            __METHOD__,
            [
                'location1ParentId' => $location1ParentId,
                'location1Id' => $location1Id,
                'location2ParentId' => $location2ParentId,
                'location2Id' => $location2Id,
            ]
        );

        $return = $this->persistenceHandler->urlAliasHandler()->locationSwapped(
            $location1ParentId,
            $location1Id,
            $location2ParentId,
            $location2Id
        );

        $this->clearLocation($location1Id);
        $this->clearLocation($location2Id);

        return $return;
    }
}


1		<?php
2
3		/**
4		* File containing the UrlAlias Handler 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		* @version //autogentag//
10		*/
11		namespace eZ\Publish\Core\Persistence\Cache;
12
13		use eZ\Publish\API\Repository\Exceptions\NotFoundException as APINotFoundException;
14		use eZ\Publish\Core\Base\Exceptions\NotFoundException;
15		use eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler as UrlAliasHandlerInterface;
16		use eZ\Publish\SPI\Persistence\Content\UrlAlias;
17
18		/**
19		* @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler
20		*/
21		class UrlAliasHandler extends AbstractHandler implements UrlAliasHandlerInterface
22		{
23		/**
24		* Constant used for storing not found results for lookup().
25		*/
26		const NOT_FOUND = 0;
27
28		/**
29		* @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::publishUrlAliasForLocation
30		*/
31		public function publishUrlAliasForLocation(
32		$locationId,
33		$parentLocationId,
34		$name,
35		$languageCode,
36		$alwaysAvailable = false,
37		$updatePathIdentificationString = false
38		) {
39		$this->logger->logCall(
40		__METHOD__,
41		array(
42		'location' => $locationId,
43		'parent' => $parentLocationId,
44		'name' => $name,
45		'language' => $languageCode,
46		'alwaysAvailable' => $alwaysAvailable,
47		)
48		);
49		$this->clearLocation($locationId);
50
51		$this->persistenceHandler->urlAliasHandler()->publishUrlAliasForLocation(
52		$locationId,
53		$parentLocationId,
54		$name,
55		$languageCode,
56		$alwaysAvailable,
57		$updatePathIdentificationString
58		);
59		}
60
61		/**
62		* @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::createCustomUrlAlias
63		*/
64		public function createCustomUrlAlias($locationId, $path, $forwarding = false, $languageCode = null, $alwaysAvailable = false)
65		{
66		$this->logger->logCall(
67		__METHOD__,
68		array(
69		'location' => $locationId,
70		'$path' => $path,
71		'$forwarding' => $forwarding,
72		'language' => $languageCode,
73		'alwaysAvailable' => $alwaysAvailable,
74		)
75		);
76
77		$urlAlias = $this->persistenceHandler->urlAliasHandler()->createCustomUrlAlias(
78		$locationId,
79		$path,
80		$forwarding,
81		$languageCode,
82		$alwaysAvailable
83		);
84
85		$this->cache->getItem('urlAlias', $urlAlias->id)->set($urlAlias)->save();
86		$cache = $this->cache->getItem('urlAlias', 'location', $urlAlias->destination, 'custom');
87		$urlAliasIds = $cache->get();
88		if ($cache->isMiss()) {
89		$urlAliasIds = array();
90		}
91
92		$urlAliasIds[] = $urlAlias->id;
93		$cache->set($urlAliasIds)->save();
94
95		return $urlAlias;
96		}
97
98		/**
99		* @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::createGlobalUrlAlias
100		*/
101		public function createGlobalUrlAlias($resource, $path, $forwarding = false, $languageCode = null, $alwaysAvailable = false)
102		{
103		$this->logger->logCall(
104		__METHOD__,
105		array(
106		'resource' => $resource,
107		'path' => $path,
108		'forwarding' => $forwarding,
109		'language' => $languageCode,
110		'alwaysAvailable' => $alwaysAvailable,
111		)
112		);
113
114		$urlAlias = $this->persistenceHandler->urlAliasHandler()->createGlobalUrlAlias(
115		$resource,
116		$path,
117		$forwarding,
118		$languageCode,
119		$alwaysAvailable
120		);
121
122		$this->cache->getItem('urlAlias', $urlAlias->id)->set($urlAlias)->save();
123
124		return $urlAlias;
125		}
126
127		/**
128		* @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::listGlobalURLAliases
129		*/
130		public function listGlobalURLAliases($languageCode = null, $offset = 0, $limit = -1)
131		{
132		$this->logger->logCall(__METHOD__, array('language' => $languageCode, 'offset' => $offset, 'limit' => $limit));
133
134		return $this->persistenceHandler->urlAliasHandler()->listGlobalURLAliases($languageCode, $offset, $limit);
135		}
136
137		/**
138		* @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::listURLAliasesForLocation
139		*/
140	View Code Duplication	public function listURLAliasesForLocation($locationId, $custom = false)
141		{
142		// Look for location to list of url alias id's cache
143		if ($custom) {
144		$cache = $this->cache->getItem('urlAlias', 'location', $locationId, 'custom');
145		} else {
146		$cache = $this->cache->getItem('urlAlias', 'location', $locationId);
147		}
148		$urlAliasIds = $cache->get();
149		if ($cache->isMiss()) {
150		$this->logger->logCall(__METHOD__, array('location' => $locationId, 'custom' => $custom));
151		$urlAliases = $this->persistenceHandler->urlAliasHandler()->listURLAliasesForLocation($locationId, $custom);
152
153		$urlAliasIds = array();
154		foreach ($urlAliases as $urlAlias) {
155		$urlAliasIds[] = $urlAlias->id;
156		}
157
158		$cache->set($urlAliasIds)->save();
159		} else {
160		// Reuse loadUrlAlias for the url alias object cache
161		$urlAliases = array();
162		foreach ($urlAliasIds as $urlAliasId) {
163		$urlAliases[] = $this->loadUrlAlias($urlAliasId);
164		}
165		}
166
167		return $urlAliases;
168		}
169
170		/**
171		* @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::removeURLAliases
172		*/
173		public function removeURLAliases(array $urlAliases)
174		{
175		$this->logger->logCall(__METHOD__, array('aliases' => $urlAliases));
176		$return = $this->persistenceHandler->urlAliasHandler()->removeURLAliases($urlAliases);
177
178		$this->cache->clear('urlAlias', 'url');//TIMBER! (no easy way to do reverse lookup of urls)
179		foreach ($urlAliases as $urlAlias) {
180		$this->cache->clear('urlAlias', $urlAlias->id);
181		if ($urlAlias->type === UrlAlias::LOCATION) {
182		$this->cache->clear('urlAlias', 'location', $urlAlias->destination);
183		}
184		if ($urlAlias->isCustom) {
185		$this->cache->clear('urlAlias', 'location', $urlAlias->destination, 'custom');
186		}
187		}
188
189		return $return;
190		}
191
192		/**
193		* @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::lookup
194		*/
195		public function lookup($url)
196		{
197		// Look for url to url alias id cache
198		// Replace slashes by "\|" to be sure not to mix cache key combinations in underlying lib.
199		$cacheKey = $url ?: '/';
200		$cache = $this->cache->getItem('urlAlias', 'url', $cacheKey);
201		$urlAliasId = $cache->get();
202		if ($cache->isMiss()) {
203		// Also cache "not found" as this function is heavliy used and hance should be cached
204		try {
205		$this->logger->logCall(__METHOD__, array('url' => $url));
206		$urlAlias = $this->persistenceHandler->urlAliasHandler()->lookup($url);
207		$cache->set($urlAlias->id)->save();
208
209		$urlAliasCache = $this->cache->getItem('urlAlias', $urlAlias->id);
210		$urlAliasCache->set($urlAlias)->save();
211		} catch (APINotFoundException $e) {
212		$cache->set(self::NOT_FOUND)->save();
213		throw $e;
214		}
215		} elseif ($urlAliasId === self::NOT_FOUND) {
216		throw new NotFoundException('UrlAlias', $url);
217		} else {
218		$urlAlias = $this->loadUrlAlias($urlAliasId);
219		}
220
221		return $urlAlias;
222		}
223
224		/**
225		* @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::loadUrlAlias
226		*/
227	View Code Duplication	public function loadUrlAlias($id)
228		{
229		// Look for url alias cache
230		$cache = $this->cache->getItem('urlAlias', $id);
231		$urlAlias = $cache->get();
232		if ($cache->isMiss()) {
233		$this->logger->logCall(__METHOD__, array('alias' => $id));
234		$urlAlias = $this->persistenceHandler->urlAliasHandler()->loadUrlAlias($id);
235		$cache->set($urlAlias)->save();
236		}
237
238		return $urlAlias;
239		}
240
241		/**
242		* @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::locationMoved
243		*/
244	View Code Duplication	public function locationMoved($locationId, $oldParentId, $newParentId)
245		{
246		$this->logger->logCall(
247		__METHOD__,
248		array(
249		'location' => $locationId,
250		'oldParent' => $oldParentId,
251		'newParent' => $newParentId,
252		)
253		);
254
255		$return = $this->persistenceHandler->urlAliasHandler()->locationMoved($locationId, $oldParentId, $newParentId);
256		$this->cache->clear('urlAlias', 'url');//TIMBER! (Will have to load url aliases for location to be able to clear specific entries)
257
258		return $return;
259		}
260
261		/**
262		* @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::locationCopied
263		*/
264	View Code Duplication	public function locationCopied($locationId, $newLocationId, $newParentId)
265		{
266		$this->logger->logCall(
267		__METHOD__,
268		array(
269		'oldLocation' => $locationId,
270		'newLocation' => $newLocationId,
271		'newParent' => $newParentId,
272		)
273		);
274
275		$return = $this->persistenceHandler->urlAliasHandler()->locationCopied(
276		$locationId,
277		$newLocationId,
278		$newParentId
279		);
280		$this->cache->clear('urlAlias', 'url'); // required due to caching not found aliases
281
282		return $return;
283		}
284
285		/**
286		* @see eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::locationDeleted
287		*/
288		public function locationDeleted($locationId)
289		{
290		$this->logger->logCall(__METHOD__, array('location' => $locationId));
291		$return = $this->persistenceHandler->urlAliasHandler()->locationDeleted($locationId);
292
293		$this->clearLocation($locationId);
294
295		return $return;
296		}
297
298		/**
299		* @param $locationId
300		*/
301		protected function clearLocation($locationId)
302		{
303		$locationCache = $this->cache->getItem('urlAlias', 'location', $locationId);
304
305		if ($locationCache->isMiss()) {
306		// we need to clear all if we don't have location id in cache
307		$this->cache->clear('urlAlias');
308		} else {
309		$urlAliasIds = $locationCache->get();
310		foreach ((array) $urlAliasIds as $urlAliasId) {
311		$this->cache->clear('urlAlias', $urlAliasId);
312		}
313		$this->cache->clear('urlAlias', 'url');
314		$locationCache->clear();
315		}
316		}
317
318		/**
319		* @see \eZ\Publish\SPI\Persistence\Content\UrlAlias\Handler::swap
320		*/
321	View Code Duplication	public function locationSwapped($location1ParentId, $location1Id, $location2ParentId, $location2Id)
322		{
323		$this->logger->logCall(
324		__METHOD__,
325		[
326		'location1ParentId' => $location1ParentId,
327		'location1Id' => $location1Id,
328		'location2ParentId' => $location2ParentId,
329		'location2Id' => $location2Id,
330		]
331		);
332
333		$return = $this->persistenceHandler->urlAliasHandler()->locationSwapped(
334		$location1ParentId,
335		$location1Id,
336		$location2ParentId,
337		$location2Id
338		);
339
340		$this->clearLocation($location1Id);
341		$this->clearLocation($location2Id);
342
343		return $return;
344		}
345		}
346

ezsystems / ezpublish-kernel

Push — EZP-26146-location-swap-urlali... ( 3d141e...44a3c1 )

UrlAliasHandler::listGlobalURLAliases() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like