trait CategorizingPluginManagerTrait (View source)

Provides a trait for the CategorizingPluginManagerInterface.

The trait provides methods for categorizing plugin definitions based on a 'category' key. The plugin manager should make sure there is a default category. For that the trait's processDefinitionCategory() method can be invoked from the processDefinition() method.

Traits

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

Properties

protected TranslationInterface $stringTranslation

The string translation service.

from  StringTranslationTrait

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.

processDefinitionCategory(array $definition)

Processes a plugin definition to ensure there is a category.

string
getProviderName(string $provider)

Gets the name of a provider.

getModuleHandler()

Returns the module handler used.

getCategories()

{@inheritdoc}

getSortedDefinitions(array $definitions = NULL, $label_key = 'label')

{@inheritdoc}

getGroupedDefinitions(array $definitions = NULL, $label_key = 'label')

{@inheritdoc}

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

protected processDefinitionCategory(array $definition)

Processes a plugin definition to ensure there is a category.

If the definition lacks a category, it defaults to the providing module.

Parameters

array $definition

The plugin definition.

protected string getProviderName(string $provider)

Gets the name of a provider.

Parameters

string $provider

The machine name of a plugin provider.

Return Value

string

The human-readable module name if it exists, otherwise the machine-readable name passed.

ModuleHandlerInterface getModuleHandler()

Returns the module handler used.

Return Value

ModuleHandlerInterface

The module handler.

getCategories()

{@inheritdoc}

getSortedDefinitions(array $definitions = NULL, $label_key = 'label')

{@inheritdoc}

Parameters

array $definitions
$label_key

getGroupedDefinitions(array $definitions = NULL, $label_key = 'label')

{@inheritdoc}

Parameters

array $definitions
$label_key