Bdf\Prime\Cache\CacheKey

Complexity

Total Complexity

10

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setLifetime()	0	4	1
A	namespace()	0	3	2
A	setNamespace()	0	4	1
A	valid()	0	3	1
A	lifetime()	0	3	1
A	key()	0	3	2
A	setKey()	0	4	1

<?php

namespace Bdf\Prime\Cache;

/**
 * Class CacheKey
 */
final class CacheKey
{
    /**
     * @var string|callable
     */
    private $namespace;

Expected 1 blank line(s) before first member var; 0 found

    /**
     * @var string|callable
     */
    private $key;

    /**
     * @var integer

Expected "int" but found "integer" for @var tag in member variable comment

     */
    private $lifetime = 0;

    /**
     * CacheKey constructor.
     * @param callable|string $namespace

There must be exactly one blank line before the tags in a doc comment

     * @param callable|string $key
     * @param int $lifetime

Expected "integer" but found "int" for parameter type

     */
    public function __construct($namespace = null, $key = null, int $lifetime = 0)
    {
        $this->namespace = $namespace;
        $this->key = $key;
        $this->lifetime = $lifetime;
    }

    /**
     * @return string
     */
    public function namespace(): string
    {
        return is_string($this->namespace) ? $this->namespace : ($this->namespace)();

Inline IF statements are not allowed

    }

    /**
     * @param string|callable $namespace
     *
     * @return $this
     */
    public function setNamespace($namespace): CacheKey
    {
        $this->namespace = $namespace;
        return $this;
    }

    /**
     * @return string
     */
    public function key(): ?string
    {
        return is_string($this->key) ? $this->key : ($this->key)();

Inline IF statements are not allowed

    }

    /**
     * @param string|callable $key
     *
     * @return $this
     */
    public function setKey($key): CacheKey
    {
        $this->key = $key;
        return $this;
    }

    /**
     * @return int

Expected "integer" but found "int" for function return type

     */
    public function lifetime(): int
    {
        return $this->lifetime;
    }

    /**
     * @param int $lifetime

Expected "integer" but found "int" for parameter type

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function setLifetime(int $lifetime): CacheKey
    {
        $this->lifetime = $lifetime;
        return $this;
    }

    public function valid(): bool

Missing doc comment for function valid()

Missing function doc comment

    {
        return !empty($this->key());
    }
}