Zikula\Bundle\CoreBundle\Bundle\MetaData

Complexity

Total Complexity

42

Size/Duplication

Total Lines	314
Duplicated Lines	0 %

Importance

Changes

0

32 Methods

Rating	Name	Duplication	Size	Complexity
A	getShortName()	0	3	1
A	confirmTranslator()	0	4	2
A	getRootPath()	0	3	1
A	offsetUnset()	0	3	1
A	offsetExists()	0	3	1
A	getType()	0	3	1
A	getBasePath()	0	3	1
A	setDescription()	0	3	1
B	formatDependencies()	0	39	6
A	getThemeFilteredVersionInfoArray()	0	16	1
A	__construct()	0	20	1
A	getName()	0	3	1
A	getFilteredVersionInfoArray()	0	14	1
A	getUrl()	0	10	3
A	getPsr0()	0	3	1
A	getCapabilities()	0	3	1
A	getVersion()	0	3	1
A	getCoreCompatibility()	0	3	1
A	getExtensionType()	0	3	1
A	getClass()	0	3	1
A	setUrl()	0	3	1
A	getPsr4()	0	3	1
A	getOldNames()	0	3	1
A	getDependencies()	0	3	1
A	getDescription()	0	7	2
A	getSecuritySchema()	0	3	1
A	offsetGet()	0	5	1
A	getNamespace()	0	3	1
A	getDisplayName()	0	7	2
A	getAutoload()	0	3	1
A	setDisplayName()	0	3	1
A	offsetSet()	0	3	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Zikula package.
 *
 * Copyright Zikula Foundation - https://ziku.la/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zikula\Bundle\CoreBundle\Bundle;

use ArrayAccess;
use Exception;
use Symfony\Component\HttpKernel\Exception\PreconditionRequiredHttpException;
use Zikula\Common\Translator\TranslatorTrait;

class MetaData implements ArrayAccess
{
    use TranslatorTrait;

    public const TYPE_MODULE = 2;

    public const TYPE_SYSTEM = 3;

    public const TYPE_CORE = 4;

    public const DEPENDENCY_REQUIRED = 1;

    public const DEPENDENCY_RECOMMENDED = 2;

    public const DEPENDENCY_CONFLICTS = 3;

    private $name;

    private $version;

    private $description;

    private $type;

    private $dependencies;

    private $shortName;

    private $class;

    private $namespace;

    private $basePath;

    private $rootPath;

    private $autoload;

    private $displayName;

    private $url;

    private $oldNames;

    private $capabilities;

    private $securitySchema;

    private $extensionType;

    private $coreCompatibility;

    public function __construct(array $json = [])
    {
        $this->name = $json['name'];
        $this->version = $json['version'] ?? '';
        $this->description = $json['description'] ?? '';
        $this->type = $json['type'];
        $this->dependencies = $this->formatDependencies($json);
        $this->shortName = $json['extra']['zikula']['short-name'];
        $this->class = $json['extra']['zikula']['class'];
        $this->namespace = mb_substr($this->class, 0, mb_strrpos($this->class, '\\') + 1);
        $this->basePath = $json['extra']['zikula']['base-path'];
        $this->rootPath = $json['extra']['zikula']['root-path'];
        $this->autoload = $json['autoload'];
        $this->displayName = $json['extra']['zikula']['displayname'] ?? '';
        $this->url = $json['extra']['zikula']['url'] ?? '';
        $this->oldNames = $json['extra']['zikula']['oldnames'] ?? [];
        $this->capabilities = $json['extra']['zikula']['capabilities'] ?? [];
        $this->securitySchema = $json['extra']['zikula']['securityschema'] ?? [];
        $this->extensionType = $json['extensionType'] ?? self::TYPE_MODULE;
        $this->coreCompatibility = $json['extra']['zikula']['core-compatibility'] ?? null;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function getVersion(): string
    {
        return $this->version;
    }

    public function getShortName(): string
    {
        return $this->shortName;
    }

    public function getPsr0(): array
    {
        return $this->autoload['psr-0'] ?? [];
    }

    public function getPsr4(): array
    {
        return $this->autoload['psr-4'] ?? [];
    }

    public function getAutoload(): array
    {
        return $this->autoload;
    }

    public function getBasePath(): string
    {
        return $this->basePath;
    }

    public function getRootPath(): string
    {
        return $this->rootPath;
    }

    public function getClass(): string
    {
        return $this->class;
    }

    public function getNamespace(): string
    {
        return $this->namespace;
    }

    public function getType(): string
    {
        return $this->type;
    }

    public function getDescription(): string
    {
        $this->confirmTranslator();

        $description = $this->trans(/** @Ignore */$this->description);

        return empty($description) ? $this->description : $description;
    }

    public function setDescription(string $description): void
    {
        $this->description = $description;
    }

    public function getDependencies(): array
    {
        return $this->dependencies;
    }

    public function getDisplayName(): string
    {
        $this->confirmTranslator();

        $display_name = $this->trans(/** @Ignore */$this->displayName);

        return empty($display_name) ? $this->displayName : $display_name;
    }

    public function setDisplayName(string $name): void
    {
        $this->displayName = $name;
    }

    public function getUrl(bool $translated = true): string
    {
        if ($translated) {
            $this->confirmTranslator();
            $url = $this->trans(/** @Ignore */$this->url);

            return empty($url) ? $this->url : $url;
        }

        return $this->url;
    }

    public function setUrl(string $url): void
    {
        $this->url = $url;
    }

    public function getOldNames(): array
    {
        return $this->oldNames;
    }

    public function getCapabilities(): array
    {
        return $this->capabilities;
    }

    public function getSecuritySchema(): array
    {
        return $this->securitySchema;
    }

    public function getExtensionType(): int
    {
        return $this->extensionType;
    }

    public function getCoreCompatibility(): ?string
    {
        return $this->coreCompatibility;
    }

    private function formatDependencies(array $json = []): array
    {
        $dependencies = [];
        if (!empty($json['require'])) {
            foreach ($json['require'] as $package => $version) {
                $dependencies[] = [
                    'modname' => $package,
                    'minversion' => $version,
                    'maxversion' => $version,
                    'status' => self::DEPENDENCY_REQUIRED
                ];
            }
        } else {
            $dependencies[] = [
                'modname' => 'zikula/core',
                'minversion' => '>=1.4.1 <3.0.0',
                'maxversion' => '>=1.4.1 <3.0.0',
                'status' => self::DEPENDENCY_REQUIRED
            ];
        }
        if (!empty($json['suggest'])) {
            foreach ($json['suggest'] as $package => $reason) {
                if (mb_strpos($package, ':')) {
                    list($name, $version) = explode(':', $package, 2);
                } else {
                    $name = $package;
                    $version = '-1';
                }
                $dependencies[] = [
                    'modname' => $name,
                    'minversion' => $version,
                    'maxversion' => $version,
                    'reason' => $reason,
                    'status' => self::DEPENDENCY_RECOMMENDED
                ];
            }
        }

        return $dependencies;
    }

    private function confirmTranslator(): void
    {
        if (!isset($this->translator)) {
            throw new PreconditionRequiredHttpException(sprintf('The translator property is not set correctly in %s', __CLASS__));
        }
    }

    /**
     * Theme MetaData as array
     */
    public function getThemeFilteredVersionInfoArray(): array
    {
        $capabilities = $this->getCapabilities();

        return [
            'name' => $this->getShortName(),
            'type' => $this->getExtensionType(),
            'displayname' => $this->getDisplayName(),
            'description' => $this->getDescription(),
            'version' => $this->getVersion(),
//            'capabilities' => $this->getCapabilities(),
            // It would be better to add capabilities to DB and move to inverse in legacy code and refactor later checks. refs #3644
            'user' => $capabilities['user'] ?? true,
            'admin' => $capabilities['admin'] ?? true,
            'system' => $capabilities['system'] ?? false,
            'xhtml' => $capabilities['xhtml'] ?? true, // this is not truly valid in 2.0
        ];
    }

    /**
     * Module MetaData as array
     */
    public function getFilteredVersionInfoArray(): array
    {
        return [
            'name' => $this->getShortName(),
            'type' => $this->getExtensionType(),
            'displayname' => $this->getDisplayName(),
            'oldnames' => $this->getOldNames(),
            'description' => $this->getDescription(),
            'version' => $this->getVersion(),
            'url' => $this->getUrl(),
            'capabilities' => $this->getCapabilities(),
            'securityschema' => $this->getSecuritySchema(),
            'dependencies' => $this->getDependencies(),
            'coreCompatibility' => $this->getCoreCompatibility()
        ];
    }

    public function offsetExists($offset)
    {
        return isset($this->{$offset});
    }

    public function offsetGet($offset)
    {
        $method = 'get' . ucwords($offset);

        return $this->{$method}();
    }

    public function offsetSet($offset, $value): void
    {
        throw new Exception('Setting values by array access is not allowed.');
    }

    public function offsetUnset($offset): void
    {
        throw new Exception('Unsetting values by array access is not allowed.');
    }
}