9.5/_package_8php_source.html

<?php

namespace ‪TYPO3\CMS\Core\Package;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


class ‪Package implements ‪PackageInterface

{

    protected ‪$extensionManagerConfiguration = [];


    protected ‪$partOfFactoryDefault = false;


    protected ‪$partOfMinimalUsableSystem = false;


    protected ‪$packageKey;


    protected ‪$packagePath;


    protected ‪$protected = false;


    protected ‪$composerManifest;


    protected ‪$packageMetaData;


    public function ‪__construct(PackageManager $packageManager, ‪$packageKey, ‪$packagePath)

    {

        if (!$packageManager->isPackageKeyValid(‪$packageKey)) {

            throw new Exception\InvalidPackageKeyException('"' . ‪$packageKey . '" is not a valid package key.', 1217959511);

        }

        if (!(@is_dir(‪$packagePath) || (is_link(‪$packagePath) && is_dir(‪$packagePath)))) {

            throw new Exception\InvalidPackagePathException(sprintf('Tried to instantiate a package object for package "%s" with a non-existing package path "%s". Either the package does not exist anymore, or the code creating this object contains an error.', ‪$packageKey, ‪$packagePath), 1166631890);

        }

        if (substr(‪$packagePath, -1, 1) !== '/') {

            throw new Exception\InvalidPackagePathException(sprintf('The package path "%s" provided for package "%s" has no trailing forward slash.', ‪$packagePath, ‪$packageKey), 1166633722);

        }

        $this->packageKey = ‪$packageKey;

        $this->packagePath = ‪$packagePath;

        $this->composerManifest = $packageManager->getComposerManifest($this->packagePath);

        $this->‪loadFlagsFromComposerManifest();

        $this->createPackageMetadata($packageManager);

    }


    protected function ‪loadFlagsFromComposerManifest()

    {

        $extraFlags = $this->‪getValueFromComposerManifest('extra');

        if ($extraFlags !== null && isset($extraFlags->{'typo3/cms'}->{'Package'})) {

            foreach ($extraFlags->{'typo3/cms'}->{'Package'} as $flagName => $flagValue) {

                if (property_exists($this, $flagName)) {

                    $this->{$flagName} = $flagValue;

                }

            }

        }

    }


    protected function createPackageMetaData(PackageManager $packageManager)

    {

        $this->packageMetaData = new MetaData($this->getPackageKey());

        $this->packageMetaData->setDescription($this->getValueFromComposerManifest('description'));

        $this->packageMetaData->setVersion($this->getValueFromComposerManifest('version'));

        $requirements = $this->getValueFromComposerManifest('require');

        if ($requirements !== null) {

            foreach ($requirements as $requirement => $version) {

                $packageKey = $packageManager->getPackageKeyFromComposerName($requirement);

                // dynamically migrate 'cms' dependency to 'core' dependency

                // see also \TYPO3\CMS\Extensionmanager\Utility\ExtensionModelUtility::convertDependenciesToObjects

                if ($packageKey === 'cms') {

                    trigger_error('Extension "' . $this->packageKey . '" defines a dependency on ext:cms, which has been removed. Please remove the dependency.', E_USER_DEPRECATED);

                    $packageKey = 'core';

                }

                $constraint = new MetaData\PackageConstraint(MetaData::CONSTRAINT_TYPE_DEPENDS, $packageKey);

                $this->packageMetaData->addConstraint($constraint);

            }

        }

        $suggestions = $this->getValueFromComposerManifest('suggest');

        if ($suggestions !== null) {

            foreach ($suggestions as $suggestion => $version) {

                $packageKey = $packageManager->getPackageKeyFromComposerName($suggestion);

                $constraint = new MetaData\PackageConstraint(MetaData::CONSTRAINT_TYPE_SUGGESTS, $packageKey);

                $this->packageMetaData->addConstraint($constraint);

            }

        }

    }


    public function isPartOfFactoryDefault()

    {

        return $this->partOfFactoryDefault;

    }


    public function isPartOfMinimalUsableSystem()

    {

        return $this->partOfMinimalUsableSystem;

    }


    public function getPackageKey()

    {

        return $this->packageKey;

    }


    public function isProtected()

    {

        return $this->protected;

    }


    public function setProtected($protected)

    {

        $this->protected = (bool)$protected;

    }


    public function getPackagePath()

    {

        return $this->packagePath;

    }


    public function getPackageMetaData()

    {

        return $this->packageMetaData;

    }


    public function getPackageReplacementKeys()

    {

        // The cast to array is required since the manifest returns data with type mixed

        return (array)$this->getValueFromComposerManifest('replace') ?: [];

    }


    public function getValueFromComposerManifest($key = null)

    {

        if ($key === null) {

            return $this->composerManifest;

        }


        if (isset($this->composerManifest->{$key})) {

            $value = $this->composerManifest->{$key};

        } else {

            $value = null;

        }

        return $value;

    }

}