AbstractContentSlot::purgeHttpCache() - Code Metrics - Inspection of "Add REST ContentType Cache and Signals for cache c..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature-EZP-25696 ( 52d929...5f47d3 )

by André

created 2016-09-07 15:07 UTC

AbstractContentSlot::purgeHttpCache() A

↳ Parent: AbstractContentSlot

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	4
rs	10

<?php

/**
 * This file is part of the eZ Publish Kernel package.
 *
 * @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\MVC\Symfony\Cache\Http\SignalSlot;

use eZ\Publish\Core\SignalSlot\Signal;

/**
 * An abstract HTTP Cache purging Slot that purges cache for a Content.
 *
 * Will by default use the contentId property of the signal object, as it is the most common. Set generateTags()
 * method in case of different signals or need to clear more then the defaults.
 */
abstract class AbstractContentSlot extends AbstractSlot
{
    /**
     * Purges relevant HTTP cache for $signal.
     *
     * @param \eZ\Publish\Core\SignalSlot\Signal $signal
     *
     * @return mixed
     */
    protected function purgeHttpCache(Signal $signal)
    {
        return $this->purgeClient->purgeByTags($this->generateTags($signal));
    }

    /**
     * Default provides tags to clear content, relation, location, parent and sibling cache.
     *
     * Overload for tree operations where you also need to clear whole path.
     *
     * @param \eZ\Publish\Core\SignalSlot\Signal $signal
     *
     * @return array
     */
    protected function generateTags(Signal $signal)
    {
        $tags = [];

        if (isset($signal->contentId)) {
            $tags = ['content-'.$signal->contentId, 'relation-'.$signal->contentId];
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        if (isset($signal->locationId)) {
            $tags[] = 'location-'.$signal->locationId;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        if (isset($signal->parentLocationId)) {
            $tags[] = 'location-'.$signal->parentLocationId;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $tags[] = 'parent-'.$signal->parentLocationId;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        return $tags;
    }
}


1			<?php
2
3			/**
4			* This file is part of the eZ Publish Kernel package.
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\MVC\Symfony\Cache\Http\SignalSlot;
12
13			use eZ\Publish\Core\SignalSlot\Signal;
14
15			/**
16			* An abstract HTTP Cache purging Slot that purges cache for a Content.
17			*
18			* Will by default use the contentId property of the signal object, as it is the most common. Set generateTags()
19			* method in case of different signals or need to clear more then the defaults.
20			*/
21			abstract class AbstractContentSlot extends AbstractSlot
22			{
23			/**
24			* Purges relevant HTTP cache for $signal.
25			*
26			* @param \eZ\Publish\Core\SignalSlot\Signal $signal
27			*
28			* @return mixed
29			*/
30			protected function purgeHttpCache(Signal $signal)
31			{
32			return $this->purgeClient->purgeByTags($this->generateTags($signal));
33			}
34
35			/**
36			* Default provides tags to clear content, relation, location, parent and sibling cache.
37			*
38			* Overload for tree operations where you also need to clear whole path.
39			*
40			* @param \eZ\Publish\Core\SignalSlot\Signal $signal
41			*
42			* @return array
43			*/
44			protected function generateTags(Signal $signal)
45			{
46			$tags = [];
47
48			if (isset($signal->contentId)) {
49			$tags = ['content-'.$signal->contentId, 'relation-'.$signal->contentId];
			0 ignored issues – show Documentation introduced 2016-09-07 15:29 UTC by Report Bug Copy Issue Report The property `contentId` does not exist on `object<eZ\Publish\Core\SignalSlot\Signal>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
50			}
51
52			if (isset($signal->locationId)) {
53			$tags[] = 'location-'.$signal->locationId;
			0 ignored issues – show Documentation introduced 2016-09-07 15:29 UTC by Report Bug Copy Issue Report The property `locationId` does not exist on `object<eZ\Publish\Core\SignalSlot\Signal>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
54			}
55
56			if (isset($signal->parentLocationId)) {
57			$tags[] = 'location-'.$signal->parentLocationId;
			0 ignored issues – show Documentation introduced 2016-09-07 15:29 UTC by Report Bug Copy Issue Report The property `parentLocationId` does not exist on `object<eZ\Publish\Core\SignalSlot\Signal>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
58			$tags[] = 'parent-'.$signal->parentLocationId;
			0 ignored issues – show Documentation introduced 2016-09-07 15:29 UTC by Report Bug Copy Issue Report The property `parentLocationId` does not exist on `object<eZ\Publish\Core\SignalSlot\Signal>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
59			}
60
61			return $tags;
62			}
63			}
64

ezsystems / ezpublish-kernel

Push — feature-EZP-25696 ( 52d929...5f47d3 )

AbstractContentSlot::purgeHttpCache() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like