CacheKey::__construct() - Code Metrics - Inspection of "Catalog package interface refactoring" - wambo-co/module-catalog - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — develop (#2)

by Andreas

created 2016-07-15 19:53 UTC

CacheKey::__construct() A

↳ Parent: CacheKey

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	7
c	0
b	0
f	0
ccs	5
cts	5
cp	1
rs	9.4285
cc	1
eloc	4
nc	1
nop	2
crap	1

<?php
namespace Wambo\Catalog\Cache;

use Wambo\Core\Module\Exception\InvalidArgumentException;
use Wambo\Core\ValueObject\ValueObjectInterface;
use Wambo\Core\ValueObject\ValueObjectTrait;

/**
 * Class CacheKey represents a single cache key used to identify elements in a cache storage.
 *
 * @package Wambo\Catalog\Cache
 */
class CacheKey implements ValueObjectInterface
{
    use ValueObjectTrait;
    private $value;

    /**
     * Create a new cache key instance for the given element name and tags.
     *
     * @param string    $elementName A name of the element that you want to cache
     * @param \string[] $tags        A list of tags that help to categorize the element you want to cache
     *
     * @return CacheKey

     */
    function __construct(string $elementName, string ...$tags)

    {
        $key = sprintf("%s--%s", $this->getCacheKeyPrefix(...$tags), $this->getCleanedName($elementName));
        $this->value = $key;

        $this->setConstructed();
    }

    /**
     * Get the value of the cache key
     *
     * @return string
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Get a cache key prefix from the given tags (default: "none")
     *
     * @param \string[] ...$tags A list of tags that help to categorize the element you want to cache
     *
     * @return string
     */
    private function getCacheKeyPrefix(string ...$tags): string
    {
        if (count($tags) === 0) {
            return "none"; // default prefix if no tags were given
        }

        // sort the tags alphabetically
        sort($tags);

        // assemble the prefix
        $prefix = "";
        foreach ($tags as $tag) {

            $cleanedTag = $this->getCleanedName($tag);

            if (strlen($prefix) == 0) {
                $prefix = "$cleanedTag";
                continue;
            }

            $prefix = "$prefix,$cleanedTag";
        }

        return $prefix;
    }

    /**
     * Get a cleaned cache key name for the given element name
     *
     * @param string $elementName
     *
     * @return string
     *
     * @throws InvalidArgumentException If the given element name is empty
     */
    private function getCleanedName(string $elementName): string
    {
        $trimmedElementName = trim($elementName);
        if (strlen($trimmedElementName) == 0) {
            throw new InvalidArgumentException("The element name cannot be empty");
        }

        return strtolower($trimmedElementName);
    }
}

1		<?php
2		namespace Wambo\Catalog\Cache;
3
4		use Wambo\Core\Module\Exception\InvalidArgumentException;
5		use Wambo\Core\ValueObject\ValueObjectInterface;
6		use Wambo\Core\ValueObject\ValueObjectTrait;
7
8		/**
9		* Class CacheKey represents a single cache key used to identify elements in a cache storage.
10		*
11		* @package Wambo\Catalog\Cache
12		*/
13		class CacheKey implements ValueObjectInterface
14		{
15		use ValueObjectTrait;
16		private $value;
17
18		/**
19		* Create a new cache key instance for the given element name and tags.
20		*
21		* @param string $elementName A name of the element that you want to cache
22		* @param \string[] $tags A list of tags that help to categorize the element you want to cache
23		*
24		* @return CacheKey
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-07-15 19:54 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
25		*/
26	17	function __construct(string $elementName, string ...$tags)
		0 ignored issues – show Best Practice introduced 2016-07-15 19:54 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
27		{
28	17	$key = sprintf("%s--%s", $this->getCacheKeyPrefix(...$tags), $this->getCleanedName($elementName));
29	12	$this->value = $key;
30
31	12	$this->setConstructed();
32	12	}
33
34		/**
35		* Get the value of the cache key
36		*
37		* @return string
38		*/
39	6	public function getValue()
40		{
41	6	return $this->value;
42		}
43
44		/**
45		* Get a cache key prefix from the given tags (default: "none")
46		*
47		* @param \string[] ...$tags A list of tags that help to categorize the element you want to cache
48		*
49		* @return string
50		*/
51	17	private function getCacheKeyPrefix(string ...$tags): string
52		{
53	17	if (count($tags) === 0) {
54	11	return "none"; // default prefix if no tags were given
55		}
56
57		// sort the tags alphabetically
58	6	sort($tags);
59
60		// assemble the prefix
61	6	$prefix = "";
62	6	foreach ($tags as $tag) {
63
64	6	$cleanedTag = $this->getCleanedName($tag);
65
66	3	if (strlen($prefix) == 0) {
67	3	$prefix = "$cleanedTag";
68	3	continue;
69		}
70
71	2	$prefix = "$prefix,$cleanedTag";
72		}
73
74	3	return $prefix;
75		}
76
77		/**
78		* Get a cleaned cache key name for the given element name
79		*
80		* @param string $elementName
81		*
82		* @return string
83		*
84		* @throws InvalidArgumentException If the given element name is empty
85		*/
86	17	private function getCleanedName(string $elementName): string
87		{
88	17	$trimmedElementName = trim($elementName);
89	17	if (strlen($trimmedElementName) == 0) {
90	5	throw new InvalidArgumentException("The element name cannot be empty");
91		}
92
93	12	return strtolower($trimmedElementName);
94		}
95		}

wambo-co / module-catalog

Pull Request — develop (#2)

CacheKey::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like