final class ProjectSecurityRequirement (View source)

internal  This class implements logic to determine security coverage for Drupal core according to Drupal core security policy. It should not be called directly.
 

Class for generating a project's security requirement.

Traits

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

Properties

protected TranslationInterface $stringTranslation

The string translation service.

from  StringTranslationTrait
protected string|null $projectTitle

The project title.

Methods

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

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

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

Formats a string containing a count of items.

getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

getStringTranslation()

Gets the string translation service.

$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

createFromProjectDataAndSecurityCoverageInfo(array $project_data, array $security_coverage_info)

Creates a ProjectSecurityRequirement object from project data.

array
getRequirement()

Gets the security coverage requirement, if any.

Details

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

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

protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

static ProjectSecurityRequirement createFromProjectDataAndSecurityCoverageInfo(array $project_data, array $security_coverage_info)

Creates a ProjectSecurityRequirement object from project data.

Parameters

array $project_data

Project data from Drupal\update\UpdateManagerInterface::getProjects(). The 'security_coverage_info' key should be set by calling \Drupal\update\ProjectSecurityData::getCoverageInfo() before calling this method. The following keys are used in this method:

  • existing_version (string): The version of the project that is installed on the site.
  • project_type (string): The type of project.
  • name (string): The project machine name.
  • title (string): The project title.
array $security_coverage_info

The security coverage information as returned by \Drupal\update\ProjectSecurityData::getCoverageInfo().

Return Value

ProjectSecurityRequirement

See also

UpdateManagerInterface::getProjects
ProjectSecurityData::getCoverageInfo
update_process_project_info()

array getRequirement()

Gets the security coverage requirement, if any.

Return Value

array

Requirements array as specified by hook_requirements(), or an empty array if no requirements can be determined.