Shopware\Storefront\Framework\Cache\Annotation\HttpCache

Complexity

Total Complexity

7

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setMaxAge()	0	8	1
A	setStates()	0	8	1
A	getMaxAge()	0	8	1
A	getStates()	0	8	1
A	allowArray()	0	8	1
A	getAliasName()	0	8	1
A	__construct()	0	9	1

<?php declare(strict_types=1);

namespace Shopware\Storefront\Framework\Cache\Annotation;

use Shopware\Core\Framework\Feature;

/**
 * @package storefront
 *
 * @Annotation
 *
 * @deprecated tag:v6.6.0 - Will be removed use `defaults: {"_httpCache"=true}` or `{"_httpCache"={"maxAge": 360, "states": {"logged-in", "cart-filled"}}}` instead
 */
class HttpCache
{
    public const ALIAS = 'httpCache';

    private ?int $maxAge = null;

    /**
     * @var list<string>|null

The type Shopware\Storefront\Framework\Cache\Annotation\list was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    private ?array $states = null;

    /**
     * @param array{maxAge?: int, states?: list<string>} $values

The doc comment array{maxAge?: int, states?: list<string>} at position 8 could not be parsed: Expected '}' at position 8, but found 'list'.

     */
    public function __construct(array $values)
    {
        Feature::triggerDeprecationOrThrow(
            'v6.6.0.0',
            Feature::deprecatedClassMessage(__CLASS__, 'v6.6.0.0')
        );

        $this->maxAge = $values['maxAge'] ?? null;
        $this->states = $values['states'] ?? null;
    }

    public function getAliasName(): string
    {
        Feature::triggerDeprecationOrThrow(
            'v6.6.0.0',
            Feature::deprecatedClassMessage(__CLASS__, 'v6.6.0.0')
        );

        return self::ALIAS;
    }

    public function allowArray(): bool
    {
        Feature::triggerDeprecationOrThrow(
            'v6.6.0.0',
            Feature::deprecatedClassMessage(__CLASS__, 'v6.6.0.0')
        );

        return true;
    }

    public function getMaxAge(): ?int
    {
        Feature::triggerDeprecationOrThrow(
            'v6.6.0.0',
            Feature::deprecatedClassMessage(__CLASS__, 'v6.6.0.0')
        );

        return $this->maxAge;
    }

    public function setMaxAge(?int $maxAge): void
    {
        Feature::triggerDeprecationOrThrow(
            'v6.6.0.0',
            Feature::deprecatedClassMessage(__CLASS__, 'v6.6.0.0')
        );

        $this->maxAge = $maxAge;
    }

    /**
     * @return list<string>
     */
    public function getStates(): array
    {
        Feature::triggerDeprecationOrThrow(
            'v6.6.0.0',
            Feature::deprecatedClassMessage(__CLASS__, 'v6.6.0.0')
        );

        return $this->states ?? [];

The expression return $this->states ?? array() returns the type array which is incompatible with the documented return type Shopware\Storefront\Framework\Cache\Annotation\list.

    }

    /**
     * @param list<string>|null $states
     */
    public function setStates(?array $states): void
    {
        Feature::triggerDeprecationOrThrow(
            'v6.6.0.0',
            Feature::deprecatedClassMessage(__CLASS__, 'v6.6.0.0')
        );

        $this->states = $states;

It seems like $states of type array is incompatible with the declared type Shopware\Storefront\Framework\Cache\Annotation\list of property $states.

    }
}