IndexerOffset::setDefinition() - Code Metrics - Inspection of "Merge branch 'next-29953/fix-indexeroffset-deseria..." - shopware/platform - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — trunk ( a4e569...0674cc )

by Christian
created 2023-08-17 09:29 UTC
IndexerOffset::setDefinition() A

↳ Parent: IndexerOffset
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php declare(strict_types=1);

namespace Shopware\Elasticsearch\Framework\Indexing;

use Shopware\Core\Framework\Feature;
use Shopware\Core\Framework\Log\Package;
use Shopware\Elasticsearch\Framework\AbstractElasticsearchDefinition;

#[Package('core')]
class IndexerOffset
{
    /**
     * @var list<string>
filter:
    dependency_paths: ["lib/*"]
     */
    protected array $definitions;

    /**
     * @var list<string>
     */
    protected array $allDefinitions;

    /**
     * @deprecated tag:v6.6.0 - Property $languageId will be removed.
     */
    protected ?string $languageId = null;

    protected ?string $definition = null;

    /**
     * @param list<string> $languages
     * @param iterable<AbstractElasticsearchDefinition>|iterable<string> $mappingDefinitions
     * @param array{offset: int|null}|null $lastId
     *
     * @deprecated tag:v6.6.0 - Parameter $languages will be removed.
     */
    public function __construct(
        protected array $languages,
        iterable $mappingDefinitions,
        protected ?int $timestamp,
        protected ?array $lastId = null
    ) {
        $mapping = [];
        /** @var AbstractElasticsearchDefinition|string $mappingDefinition */
        foreach ($mappingDefinitions as $mappingDefinition) {
            if ($mappingDefinition instanceof AbstractElasticsearchDefinition) {
                Feature::triggerDeprecationOrThrow('v6.6.0.0', 'Passing definitions objects is deprecated. Pass the entity name instead.');
                $mapping[] = $mappingDefinition->getEntityDefinition()->getEntityName();
            } else {
                $mapping[] = $mappingDefinition;
            }
        }

        $this->allDefinitions = $mapping;

        $this->definitions = $mapping;


        if (!Feature::isActive('ES_MULTILINGUAL_INDEX')) {
            $this->selectNextLanguage();
            /** @scrutinizer ignore-deprecated */ $this->selectNextLanguage();
        }

        $this->selectNextDefinition();
        /** @scrutinizer ignore-deprecated */ $this->selectNextDefinition();
    }

    /**
     * @deprecated tag:v6.6.0 - Will be removed. Use selectNextDefinition instead
     *
     * @phpstan-ignore-next-line ignore needs to be removed when deprecation is removed
     */
    public function setNextDefinition(): ?string
    {
        Feature::triggerDeprecationOrThrow(
            'v6.6.0.0',
            Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.6.0.0', 'selectNextDefinition')
        );

        return $this->selectNextDefinition();
        return /** @scrutinizer ignore-deprecated */ $this->selectNextDefinition();
    }

    /**
     * @deprecated tag:v6.6.0 - reason:return-type-change - will be changed to void and not return anything anymore
     */
    public function selectNextDefinition(): ?string
    {
        return $this->definition = array_shift($this->definitions);
    }

    public function resetDefinitions(): void
    {
        $this->definitions = $this->allDefinitions;

        $this->definition = array_shift($this->definitions);
    }

    public function hasNextDefinition(): bool
    {
        return !empty($this->definitions);
    }

    /**
     * @deprecated tag:v6.6.0 - reason:remove-getter-setter - will be removed.
     *
     * @phpstan-ignore-next-line ignore needs to be removed when deprecation is removed
     */
    public function setNextLanguage(): ?string
    {
        Feature::triggerDeprecationOrThrow(
            'v6.6.0.0',
            Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.6.0.0', 'selectNextLanguage')
        );

        return $this->selectNextLanguage();
        return /** @scrutinizer ignore-deprecated */ $this->selectNextLanguage();
    }

    /**
     * @deprecated tag:v6.6.0 - reason:remove-getter-setter - will be removed.
     */
    public function selectNextLanguage(): ?string
    {
        return $this->languageId = array_shift($this->languages);
        return /** @scrutinizer ignore-deprecated */ $this->languageId = array_shift($this->languages);
    }

    /**
     * @deprecated tag:v6.6.0 - reason:remove-getter-setter - will be removed.
     */
    public function hasNextLanguage(): bool
    {
        return !empty($this->languages);
    }

    /**
     * @deprecated tag:v6.6.0 - reason:remove-getter-setter - will be removed.
     */
    public function getLanguageId(): ?string
    {
        return $this->languageId;
        return /** @scrutinizer ignore-deprecated */ $this->languageId;
    }

    /**
     * @return list<string>
     *
     * @deprecated tag:v6.6.0 - reason:remove-getter-setter - will be removed.
     */
    public function getLanguages(): array
    {
        return $this->languages;

    }

    /**
     * @return list<string>
     */
    public function getDefinitions(): array
    {
        return $this->definitions;

    }

    public function getTimestamp(): ?int
    {
        return $this->timestamp;
    }

    /**
     * @return array{offset: int|null}|null
     */
    public function getLastId(): ?array
    {
        return $this->lastId;
    }

    public function getDefinition(): ?string
    {
        return $this->definition;
    }

    /**
     * @param array{offset: int|null}|null $lastId
     */
    public function setLastId(?array $lastId): void
    {
        $this->lastId = $lastId;
    }

    /**
     * @internal This method is internal and will be used by Symfony serializer
     *
     * @return array<string>
     */
    public function getAllDefinitions(): array
    {
        return $this->allDefinitions;
    }

    /**
     * @param list<string> $allDefinitions
     *
     * @internal This method is internal and will be used by Symfony serializer
     */
    public function setAllDefinitions(array $allDefinitions): void
    {
        $this->allDefinitions = $allDefinitions;

    }

    /**
     * @param list<string> $definitions
     *
     * @internal This method is internal and will be used by Symfony serializer
     */
    public function setDefinitions(array $definitions): void
    {
        $this->definitions = $definitions;

    }

    /**
     * @deprecated tag:v6.6.0 - reason:remove-getter-setter - will be removed.
     *
     * @internal This method is internal and will be used by Symfony serializer
     */
    public function setLanguageId(?string $languageId): void
    {
        $this->languageId = $languageId;
        /** @scrutinizer ignore-deprecated */ $this->languageId = $languageId;
    }

    /**
     * @internal This method is internal and will be used by Symfony serializer
     */
    public function setDefinition(?string $definition): void
    {
        $this->definition = $definition;
    }
}

shopware / platform

Push — trunk ( a4e569...0674cc )

IndexerOffset::setDefinition() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
