class Dependency

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Extension/Dependency.php \Drupal\Core\Extension\Dependency
  2. 10 core/lib/Drupal/Core/Extension/Dependency.php \Drupal\Core\Extension\Dependency
  3. 11.x core/lib/Drupal/Core/Extension/Dependency.php \Drupal\Core\Extension\Dependency

A value object representing dependency information.

Hierarchy

Expanded class hierarchy of Dependency

2 files declare their use of Dependency
DependencyTest.php in core/tests/Drupal/Tests/Core/Extension/DependencyTest.php
install.inc in core/includes/install.inc
API functions for installing modules and themes.
5 string references to 'Dependency'
DependencyTest::testModuleEnableOrder in core/modules/system/tests/src/Functional/Module/DependencyTest.php
Tests that module dependencies are enabled in the correct order in the UI.
ModuleHandlerTest::testDependencyResolution in core/modules/system/tests/src/Kernel/Extension/ModuleHandlerTest.php
Tests dependency resolution.
ModuleHandlerTest::testUninstallContentDependency in core/modules/system/tests/src/Kernel/Extension/ModuleHandlerTest.php
Tests uninstalling a module that has content.
module_test_system_info_alter in core/modules/system/tests/modules/module_test/module_test.module
Implements hook_system_info_alter().
SearchExcerptTest::testSearchExcerptSimplified in core/modules/search/tests/src/Kernel/SearchExcerptTest.php
Tests search_excerpt() with search keywords matching simplified words.

File

core/lib/Drupal/Core/Extension/Dependency.php, line 10

Namespace

Drupal\Core\Extension
View source 
class Dependency {
    
    /**
     * 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);
    }
    
    /**
     * 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) {
            [
                $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 serialize.
     */
    public function __sleep() {
        return [
            'name',
            'project',
            'constraintString',
        ];
    }

}

Members

Title Modifiers Object type Summary
Dependency::$constraint protected property The Constraint object from the constraint string.
Dependency::$constraintString protected property The constraint string.
Dependency::$name protected property The name of the dependency.
Dependency::$project protected property The project namespace for the dependency.
Dependency::createFromString public static function Creates a new instance of this class from a dependency string.
Dependency::getConstraint protected function Gets the Constraint object.
Dependency::getConstraintString public function Gets constraint string from the dependency.
Dependency::getName public function Gets the dependency&#039;s name.
Dependency::getProject public function Gets the dependency&#039;s project namespace.
Dependency::isCompatible public function Determines if the provided version is compatible with this dependency.
Dependency::__construct public function Dependency constructor.
Dependency::__sleep public function Prevents unnecessary serialization of constraint objects.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.