1. class
  2. Drupal
  3. \
  4. update
  5. \
  6. ProjectCoreCompatibility

ProjectCoreCompatibility

final class ProjectCoreCompatibility (View source)

internal  This class implements logic used by update_calculate_project_status(). It should not be called directly.
 

Utility class to set core compatibility messages for project releases.

Traits

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

Properties

protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected string $existingCoreVersion

The currently installed version of Drupal core.
protected string[] $possibleCoreUpdateVersions

Cache of core versions that are available for updates.
protected string[] $compatibilityMessages

Cache of core compatibility messages per core version constraint.

Methods

TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
__construct(array $core_data, array $core_releases)

Constructs a ProjectCoreCompatibility object.

string[]
getPossibleCoreUpdateVersions(array $core_releases)

Gets the core versions that should be considered for compatibility ranges.

setReleaseMessage(array $project_data)

Sets core compatibility messages for project releases.

bool
isCoreCompatible(string $core_compatibility_constraint)

Determines if a release is compatible with the currently installed core.

string
createMessageFromCoreCompatibility(string $core_compatibility_constraint)

Creates core a compatibility message from a semantic version constraint.

array[]
getCompatibilityRanges(string $core_compatibility_constraint)

Gets the compatibility ranges for a semantic version constraint.

Details

in StringTranslationTrait at line 70
protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Parameters

string $string

A string containing the English text to translate.
array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

at line 62
__construct(array $core_data, array $core_releases)

Constructs a ProjectCoreCompatibility object.

Parameters

array $core_data

The project data for Drupal core as returned by \Drupal\update\UpdateManagerInterface::getProjects() and then processed by update_process_project_info() and update_calculate_project_update_status().
array $core_releases

The Drupal core available releases.

See also

UpdateManagerInterface::getProjects
update_process_project_info()
update_calculate_project_update_status()

at line 78
protected string[] getPossibleCoreUpdateVersions(array $core_releases)

Gets the core versions that should be considered for compatibility ranges.

Parameters

array $core_releases

The Drupal core available releases.

Return Value

string[]

The core version numbers that are possible to update the site to.

at line 114
setReleaseMessage(array $project_data)

Sets core compatibility messages for project releases.

Parameters

array $project_data

The project data as returned by \Drupal\update\UpdateManagerInterface::getProjects() and then processed by update_process_project_info() and update_calculate_project_update_status(). If set, the following keys are used in this method:

  • recommended (string): A project version number.
  • latest_version (string): A project version number.
  • also (string[]): Project version numbers.
  • releases (array[]): An array where the keys are project version numbers and the values are arrays of project release information.
  • security updates (array[]): An array of project release information.

See also

UpdateManagerInterface::getProjects
update_process_project_info()
update_calculate_project_update_status()

at line 160
protected bool isCoreCompatible(string $core_compatibility_constraint)

Determines if a release is compatible with the currently installed core.

Parameters

string $core_compatibility_constraint

A semantic version constraint.

Return Value

bool

TRUE if the given constraint is satisfied by the currently installed version of Drupal core, otherwise FALSE.

at line 173
protected string createMessageFromCoreCompatibility(string $core_compatibility_constraint)

Creates core a compatibility message from a semantic version constraint.

Parameters

string $core_compatibility_constraint

A semantic version constraint.

Return Value

string

The core compatibility message.

at line 202
protected array[] getCompatibilityRanges(string $core_compatibility_constraint)

Gets the compatibility ranges for a semantic version constraint.

Parameters

string $core_compatibility_constraint

A semantic version constraint.

Return Value

array[]

An array compatibility ranges. If a range array has 2 elements then this denotes a range of compatibility between and including the 2 versions. If the range has 1 element then it denotes compatibility with a single version.