Constraint.php
Same filename in this branch
Same filename in other branches
- 9 core/lib/Drupal/Core/Validation/Annotation/Constraint.php
- 9 core/lib/Drupal/Component/Version/Constraint.php
- 10 core/lib/Drupal/Core/Validation/Attribute/Constraint.php
- 10 core/lib/Drupal/Core/Validation/Annotation/Constraint.php
- 10 core/lib/Drupal/Component/Version/Constraint.php
- 11.x core/lib/Drupal/Core/Validation/Attribute/Constraint.php
- 11.x core/lib/Drupal/Core/Validation/Annotation/Constraint.php
- 11.x core/lib/Drupal/Component/Version/Constraint.php
Namespace
Drupal\Component\VersionFile
-
core/
lib/ Drupal/ Component/ Version/ Constraint.php
View source
<?php
namespace Drupal\Component\Version;
/**
* A value object representing a Drupal version constraint.
*/
class Constraint {
/**
* The constraint represented as a string. For example '>=8.x-5.x'.
*
* @var string
*/
protected $constraint;
/**
* A list of associative arrays representing the constraint.
*
* Each containing the keys:
* - 'op': can be one of: '=', '==', '!=', '<>', '<', '<=', '>', or '>='.
* - 'version': A complete version, e.g. '4.5-beta3'.
*
* @var array[]
*/
protected $constraintArray = [];
/**
* Constraint constructor.
*
* @param string $constraint
* The constraint string to create the object from. For example, '>8.x-1.1'.
* @param string $core_compatibility
* Core compatibility declared for the current version of Drupal core.
* Normally this is set to \Drupal::CORE_COMPATIBILITY by the caller.
*/
public function __construct($constraint, $core_compatibility) {
$this->constraint = $constraint;
$this->parseConstraint($constraint, $core_compatibility);
}
/**
* Gets the constraint as a string.
*
* Can be used in the UI for reporting incompatibilities.
*
* @return string
* The constraint as a string.
*/
public function __toString() {
return $this->constraint;
}
/**
* A list of associative arrays representing the constraint.
*
* Each containing the keys:
* - 'op': can be one of: '=', '==', '!=', '<>', '<', '<=', '>', or '>='.
* - 'version': A complete version, e.g. '4.5-beta3'.
*
* @return array[]
* The constraint represented as an array.
*
* @deprecated in drupal:8.7.0 and is removed from drupal:9.0.0.
* Only exists to provide a backwards compatibility layer.
*
* @see https://www.drupal.org/node/2756875
*/
public function toArray() {
@trigger_error(sprintf('%s() only exists to provide a backwards compatibility layer. See https://www.drupal.org/node/2756875', __METHOD__), E_USER_DEPRECATED);
return $this->constraintArray;
}
/**
* Determines if the provided version is satisfied by this constraint.
*
* @param string $version
* The version to check, for example '4.2'.
*
* @return bool
* TRUE if the provided version is satisfied by this constraint, FALSE if
* not.
*/
public function isCompatible($version) {
foreach ($this->constraintArray as $constraint) {
if (!version_compare($version, $constraint['version'], $constraint['op'])) {
return FALSE;
}
}
return TRUE;
}
/**
* Parses a constraint string.
*
* @param string $constraint_string
* The constraint string to parse.
* @param string $core_compatibility
* Core compatibility declared for the current version of Drupal core.
* Normally this is set to \Drupal::CORE_COMPATIBILITY by the caller.
*/
private function parseConstraint($constraint_string, $core_compatibility) {
// We use named subpatterns and support every op that version_compare
// supports. Also, op is optional and defaults to equals.
$p_op = '(?<operation>!=|==|=|<|<=|>|>=|<>)?';
// Core version is always optional: 8.x-2.x and 2.x is treated the same.
$p_core = '(?:' . preg_quote($core_compatibility) . '-)?';
$p_major = '(?<major>\\d+)';
// By setting the minor version to x, branches can be matched.
$p_minor = '(?<minor>(?:\\d+|x)(?:-[A-Za-z]+\\d+)?)';
foreach (explode(',', $constraint_string) as $constraint) {
if (preg_match("/^\\s*{$p_op}\\s*{$p_core}{$p_major}\\.{$p_minor}/", $constraint, $matches)) {
$op = !empty($matches['operation']) ? $matches['operation'] : '=';
if ($matches['minor'] == 'x') {
// Drupal considers "2.x" to mean any version that begins with
// "2" (e.g. 2.0, 2.9 are all "2.x"). PHP's version_compare(),
// on the other hand, treats "x" as a string; so to
// version_compare(), "2.x" is considered less than 2.0. This
// means that >=2.x and <2.x are handled by version_compare()
// as we need, but > and <= are not.
if ($op == '>' || $op == '<=') {
$matches['major']++;
}
// Equivalence can be checked by adding two restrictions.
if ($op == '=' || $op == '==') {
$this->constraintArray[] = [
'op' => '<',
'version' => $matches['major'] + 1 . '.x',
];
$op = '>=';
}
}
$this->constraintArray[] = [
'op' => $op,
'version' => $matches['major'] . '.' . $matches['minor'],
];
}
}
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
Constraint | A value object representing a Drupal version constraint. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.