Dependency.php

<?php

namespace Drupal\Core\Extension;

use Drupal\Component\Version\Constraint;

/**
 * A value object representing dependency information.
 *
 * This class implements \ArrayAccess to provide a backwards compatibility layer
 * for Drupal 8.x. This will be removed before Drupal 9.x.
 *
 * @see https://www.drupal.org/node/2756875
 */
class Dependency implements \ArrayAccess {
    
    /**
     * The name of the dependency.
     *
     * @var string
     */
    protected $name;
    
    /**
     * The project namespace for the dependency.
     *
     * @var string
     */
    protected $project;
    
    /**
     * The constraint string.
     *
     * @var \Drupal\Component\Version\Constraint
     */
    protected $constraintString;
    
    /**
     * The Constraint object from the constraint string.
     *
     * @var \Drupal\Component\Version\Constraint
     */
    protected $constraint;
    
    /**
     * Dependency constructor.
     *
     * @param string $name
     *   The name of the dependency.
     * @param string $project
     *   The project namespace for the dependency.
     * @param string $constraint
     *   The constraint string. For example, '>8.x-1.1'.
     */
    public function __construct($name, $project, $constraint) {
        $this->name = $name;
        $this->project = $project;
        $this->constraintString = $constraint;
    }
    
    /**
     * Gets the dependency's name.
     *
     * @return string
     *   The dependency's name.
     */
    public function getName() {
        return $this->name;
    }
    
    /**
     * Gets the dependency's project namespace.
     *
     * @return string
     *   The dependency's project namespace.
     */
    public function getProject() {
        return $this->project;
    }
    
    /**
     * Gets constraint string from the dependency.
     *
     * @return string
     *   The constraint string.
     */
    public function getConstraintString() {
        return $this->constraintString;
    }
    
    /**
     * Gets the Constraint object.
     *
     * @return \Drupal\Component\Version\Constraint
     *   The Constraint object.
     */
    protected function getConstraint() {
        if (!$this->constraint) {
            $this->constraint = new Constraint($this->constraintString, \Drupal::CORE_COMPATIBILITY);
        }
        return $this->constraint;
    }
    
    /**
     * Determines if the provided version is compatible with this dependency.
     *
     * @param string $version
     *   The version to check, for example '4.2'.
     *
     * @return bool
     *   TRUE if compatible with the provided version, FALSE if not.
     */
    public function isCompatible($version) {
        return $this->getConstraint()
            ->isCompatible($version);
    }
    
    /**
     * {@inheritdoc}
     */
    public function offsetExists($offset) {
        @trigger_error(sprintf('Array access to %s properties is deprecated. Use accessor methods instead. See https://www.drupal.org/node/2756875', __CLASS__), E_USER_DEPRECATED);
        return in_array($offset, [
            'name',
            'project',
            'original_version',
            'versions',
        ], TRUE);
    }
    
    /**
     * {@inheritdoc}
     */
    public function offsetGet($offset) {
        switch ($offset) {
            case 'name':
                @trigger_error(sprintf('Array access to the %s name property is deprecated. Use %s::getName() instead. See https://www.drupal.org/node/2756875', __CLASS__, __CLASS__), E_USER_DEPRECATED);
                return $this->getName();
            case 'project':
                @trigger_error(sprintf('Array access to the %s project property is deprecated. Use %s::getProject() instead. See https://www.drupal.org/node/2756875', __CLASS__, __CLASS__), E_USER_DEPRECATED);
                return $this->getProject();
            case 'original_version':
                @trigger_error(sprintf('Array access to the %s original_version property is deprecated. Use %s::getConstraintString() instead. See https://www.drupal.org/node/2756875', __CLASS__, __CLASS__), E_USER_DEPRECATED);
                $constraint = $this->getConstraintString();
                if ($constraint) {
                    $constraint = ' (' . $constraint . ')';
                }
                return $constraint;
            case 'versions':
                @trigger_error(sprintf('Array access to the %s versions property is deprecated. See https://www.drupal.org/node/2756875', __CLASS__), E_USER_DEPRECATED);
                return $this->getConstraint()
                    ->toArray();
        }
        throw new \InvalidArgumentException("The {$offset} key is not supported");
    }
    
    /**
     * {@inheritdoc}
     */
    public function offsetSet($offset, $value) {
        throw new \BadMethodCallException(sprintf('%s() is not supported', __METHOD__));
    }
    
    /**
     * {@inheritdoc}
     */
    public function offsetUnset($offset) {
        throw new \BadMethodCallException(sprintf('%s() is not supported', __METHOD__));
    }
    
    /**
     * Creates a new instance of this class from a dependency string.
     *
     * @param string $dependency
     *   A dependency string, which specifies a module or theme dependency, and
     *   optionally the project it comes from and a constraint string that
     *   determines the versions that are supported. Supported formats include:
     *   - 'module'
     *   - 'project:module'
     *   - 'project:module (>=version, <=version)'.
     *
     * @return static
     */
    public static function createFromString($dependency) {
        if (strpos($dependency, ':') !== FALSE) {
            list($project, $dependency) = explode(':', $dependency);
        }
        else {
            $project = '';
        }
        $parts = explode('(', $dependency, 2);
        $name = trim($parts[0]);
        $version_string = isset($parts[1]) ? rtrim($parts[1], ") ") : '';
        return new static($name, $project, $version_string);
    }
    
    /**
     * Prevents unnecessary serialization of constraint objects.
     *
     * @return array
     *   The properties to seriailize.
     */
    public function __sleep() {
        return [
            'name',
            'project',
            'constraintString',
        ];
    }

}