public __construct(Drupal\Core\Language\LanguageDefault $default_language) Constructs a TranslationManager object.
/**
* Constructs a TranslationManager object.
*
* @param \Drupal\Core\Language\LanguageDefault $default_language
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:52
public addTranslator(Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator, $priority = 0): $this Appends a translation system to the translation chain.
/**
* Appends a translation system to the translation chain.
*
* @param \Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator
* The translation interface to be appended to the translation chain.
* @param int $priority
* The priority of the logger being added.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:66
protected sortTranslators(): \Drupal\Core\StringTranslation\Translator\TranslatorInterface[] Sorts translators according to priority.
/**
* Sorts translators according to priority.
*
* @return \Drupal\Core\StringTranslation\Translator\TranslatorInterface[]
* A sorted array of translator objects.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
public getStringTranslation($langcode, $string, $context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104
public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112
protected doTranslate($string, array $options = array()): string Translates a string to the current language or to a given language.
/**
* Translates a string to the current language or to a given language.
*
* @param string $string
* A string containing the English text to translate.
* @param array $options
* An associative array of additional options, with the following elements:
* - 'langcode': The language code to translate to a language other than
* what is used to display the page.
* - 'context': The context the source string belongs to.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:130
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:148
public setDefaultLangcode($langcode) Sets the default langcode.
/**
* Sets the default langcode.
*
* @param string $langcode
* A language code.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158
public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:165
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
label string (40) "Metatags (Hidden field for JSON support)"
public __construct(Drupal\Core\Language\LanguageDefault $default_language) Constructs a TranslationManager object.
/**
* Constructs a TranslationManager object.
*
* @param \Drupal\Core\Language\LanguageDefault $default_language
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:52
public addTranslator(Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator, $priority = 0): $this Appends a translation system to the translation chain.
/**
* Appends a translation system to the translation chain.
*
* @param \Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator
* The translation interface to be appended to the translation chain.
* @param int $priority
* The priority of the logger being added.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:66
protected sortTranslators(): \Drupal\Core\StringTranslation\Translator\TranslatorInterface[] Sorts translators according to priority.
/**
* Sorts translators according to priority.
*
* @return \Drupal\Core\StringTranslation\Translator\TranslatorInterface[]
* A sorted array of translator objects.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
public getStringTranslation($langcode, $string, $context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104
public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112
protected doTranslate($string, array $options = array()): string Translates a string to the current language or to a given language.
/**
* Translates a string to the current language or to a given language.
*
* @param string $string
* A string containing the English text to translate.
* @param array $options
* An associative array of additional options, with the following elements:
* - 'langcode': The language code to translate to a language other than
* what is used to display the page.
* - 'context': The context the source string belongs to.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:130
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:148
public setDefaultLangcode($langcode) Sets the default langcode.
/**
* Sets the default langcode.
*
* @param string $langcode
* A language code.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158
public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:165
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (38) "The computed meta tags for the entity."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2)
tag => Drupal\Core\TypedData\DataDefinition#8836 (2)
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/MapDataDefinition.php:40
public setPropertyDefinition($name, ?Drupal\Core\TypedData\DataDefinitionInterface $definition = null): $this Sets the definition of a map property.
/**
* Sets the definition of a map property.
*
* @param string $name
* The name of the property to define.
* @param \Drupal\Core\TypedData\DataDefinitionInterface|null $definition
* (optional) The property definition to set, or NULL to unset it.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/MapDataDefinition.php:57
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/MapDataDefinition.php:70
public setMainPropertyName($name): $this Sets the main property name.
/**
* Sets the main property name.
*
* @param string|null $name
* The name of the main property, or NULL if there is none.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/MapDataDefinition.php:82
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ComplexDataDefinitionBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php:25
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ComplexDataDefinitionBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php:42
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\TypedData\MapDataDefinition::create($type = 'map'): static Creates a new map definition.
/**
* Creates a new map definition.
*
* @param string $type
* (optional) The data type of the map. Defaults to 'map'.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/MapDataDefinition.php:25
public static Drupal\Core\TypedData\MapDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/MapDataDefinition.php:33
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60
public getEntity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74
public getLangcode() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88
protected getSettings(): array Returns the array of field settings.
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98
protected getSetting($setting_name): mixed Returns the value of a field setting.
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111
public setValue($values, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118
/**
* {@inheritdoc}
*
* Different to the parent Map class, we avoid creating property objects as
* far as possible in order to optimize performance. Thus we just update
* $this->values if no property object has been created yet.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186
public view($display_options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200
public preSave() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208
public postSave($update) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218
public deleteRevision() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228
public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233
public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240
public getValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:58
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:106
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:118
public set($property_name, $value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:133
public getProperties($include_computed = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:165
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:178
public getIterator(): ArrayIterator Retrieves the iterator for the object.
/**
* Retrieves the iterator for the object.
*
* @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
* The iterator.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:192
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:219
public onChange($property_name, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*
* @param string $property_name
* The name of the property.
* @param bool $notify
* (optional) Whether to forward the notification to the parent. Defaults to
* TRUE. By passing FALSE, overrides of this method can re-use the logic
* of parent classes without triggering notification.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:236
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:246
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119
public validate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:27
public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:34
public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25
public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32
public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39
public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46
public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53
public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223
public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247
public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254
public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261
public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268
public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282
public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.
/**
* Defines field item properties.
*
* Properties that are required to constitute a valid, non-empty item should
* be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*
* @see \Drupal\Core\Field\BaseFieldDefinition
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35
abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.
/**
* Returns the schema for the field.
*
* This method is static because the field schema information is needed on
* creation of the field. FieldItemInterface objects instantiated at that
* time are not reliable as field settings might be missing.
*
* Computed fields having no schema should return an empty array.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
* The field definition.
*
* @return array
* An empty array if there is no schema, or an associative array with the
* following key/value pairs:
* - columns: An array of Schema API column specifications, keyed by column
* name. The columns need to be a subset of the properties defined in
* propertyDefinitions(). The 'not null' property is ignored if present,
* as it is determined automatically by the storage controller depending
* on the table layout and the property definitions. It is recommended to
* avoid having the column definitions depend on field settings when
* possible. No assumptions should be made on how storage engines
* internally use the original column name to structure their storage.
* - unique keys: (optional) An array of Schema API unique key definitions.
* Only columns that appear in the 'columns' array are allowed.
* - indexes: (optional) An array of Schema API index definitions. Only
* columns that appear in the 'columns' array are allowed. Those indexes
* will be used as default indexes. Field definitions can specify
* additional indexes or, at their own risk, modify the default indexes
* specified by the field-type module. Some storage engines might not
* support indexes.
* - foreign keys: (optional) An array of Schema API foreign key
* definitions. Note, however, that the field data is not necessarily
* stored in SQL. Also, the possible usage is limited, as you cannot
* specify another field as related, only existing SQL tables,
* such as {taxonomy_term_data}.
*
* @throws \Drupal\Core\Field\FieldException
* Throws an exception if the schema is invalid.
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60
public getEntity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74
public getLangcode() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88
protected getSettings(): array Returns the array of field settings.
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98
protected getSetting($setting_name): mixed Returns the value of a field setting.
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111
public setValue($values, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118
/**
* {@inheritdoc}
*
* Different to the parent Map class, we avoid creating property objects as
* far as possible in order to optimize performance. Thus we just update
* $this->values if no property object has been created yet.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186
public view($display_options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200
public preSave() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208
public postSave($update) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218
public deleteRevision() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228
public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233
public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240
public getValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:58
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:106
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:118
public set($property_name, $value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:133
public getProperties($include_computed = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:165
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:178
public getIterator(): ArrayIterator Retrieves the iterator for the object.
/**
* Retrieves the iterator for the object.
*
* @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
* The iterator.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:192
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:219
public onChange($property_name, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*
* @param string $property_name
* The name of the property.
* @param bool $notify
* (optional) Whether to forward the notification to the parent. Defaults to
* TRUE. By passing FALSE, overrides of this method can re-use the logic
* of parent classes without triggering notification.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:236
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:246
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119
public validate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:27
public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:34
public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25
public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32
public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39
public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46
public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53
public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223
public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247
public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254
public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261
public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268
public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282
public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.
/**
* Defines field item properties.
*
* Properties that are required to constitute a valid, non-empty item should
* be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*
* @see \Drupal\Core\Field\BaseFieldDefinition
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35
abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.
/**
* Returns the schema for the field.
*
* This method is static because the field schema information is needed on
* creation of the field. FieldItemInterface objects instantiated at that
* time are not reliable as field settings might be missing.
*
* Computed fields having no schema should return an empty array.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
* The field definition.
*
* @return array
* An empty array if there is no schema, or an associative array with the
* following key/value pairs:
* - columns: An array of Schema API column specifications, keyed by column
* name. The columns need to be a subset of the properties defined in
* propertyDefinitions(). The 'not null' property is ignored if present,
* as it is determined automatically by the storage controller depending
* on the table layout and the property definitions. It is recommended to
* avoid having the column definitions depend on field settings when
* possible. No assumptions should be made on how storage engines
* internally use the original column name to structure their storage.
* - unique keys: (optional) An array of Schema API unique key definitions.
* Only columns that appear in the 'columns' array are allowed.
* - indexes: (optional) An array of Schema API index definitions. Only
* columns that appear in the 'columns' array are allowed. Those indexes
* will be used as default indexes. Field definitions can specify
* additional indexes or, at their own risk, modify the default indexes
* specified by the field-type module. Some storage engines might not
* support indexes.
* - foreign keys: (optional) An array of Schema API foreign key
* definitions. Note, however, that the field data is not necessarily
* stored in SQL. Also, the possible usage is limited, as you cannot
* specify another field as related, only existing SQL tables,
* such as {taxonomy_term_data}.
*
* @throws \Drupal\Core\Field\FieldException
* Throws an exception if the schema is invalid.
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60
public getEntity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74
public getLangcode() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88
protected getSettings(): array Returns the array of field settings.
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98
protected getSetting($setting_name): mixed Returns the value of a field setting.
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111
public setValue($values, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118
/**
* {@inheritdoc}
*
* Different to the parent Map class, we avoid creating property objects as
* far as possible in order to optimize performance. Thus we just update
* $this->values if no property object has been created yet.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186
public view($display_options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200
public preSave() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208
public postSave($update) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218
public deleteRevision() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228
public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233
public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240
public getValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:58
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:106
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:118
public set($property_name, $value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:133
public getProperties($include_computed = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:165
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:178
public getIterator(): ArrayIterator Retrieves the iterator for the object.
/**
* Retrieves the iterator for the object.
*
* @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
* The iterator.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:192
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:219
public onChange($property_name, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*
* @param string $property_name
* The name of the property.
* @param bool $notify
* (optional) Whether to forward the notification to the parent. Defaults to
* TRUE. By passing FALSE, overrides of this method can re-use the logic
* of parent classes without triggering notification.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:236
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:246
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119
public validate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:27
public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:34
public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25
public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32
public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39
public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46
public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53
public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223
public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247
public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254
public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261
public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268
public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282
public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.
/**
* Defines field item properties.
*
* Properties that are required to constitute a valid, non-empty item should
* be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*
* @see \Drupal\Core\Field\BaseFieldDefinition
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35
abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.
/**
* Returns the schema for the field.
*
* This method is static because the field schema information is needed on
* creation of the field. FieldItemInterface objects instantiated at that
* time are not reliable as field settings might be missing.
*
* Computed fields having no schema should return an empty array.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
* The field definition.
*
* @return array
* An empty array if there is no schema, or an associative array with the
* following key/value pairs:
* - columns: An array of Schema API column specifications, keyed by column
* name. The columns need to be a subset of the properties defined in
* propertyDefinitions(). The 'not null' property is ignored if present,
* as it is determined automatically by the storage controller depending
* on the table layout and the property definitions. It is recommended to
* avoid having the column definitions depend on field settings when
* possible. No assumptions should be made on how storage engines
* internally use the original column name to structure their storage.
* - unique keys: (optional) An array of Schema API unique key definitions.
* Only columns that appear in the 'columns' array are allowed.
* - indexes: (optional) An array of Schema API index definitions. Only
* columns that appear in the 'columns' array are allowed. Those indexes
* will be used as default indexes. Field definitions can specify
* additional indexes or, at their own risk, modify the default indexes
* specified by the field-type module. Some storage engines might not
* support indexes.
* - foreign keys: (optional) An array of Schema API foreign key
* definitions. Note, however, that the field data is not necessarily
* stored in SQL. Also, the possible usage is limited, as you cannot
* specify another field as related, only existing SQL tables,
* such as {taxonomy_term_data}.
*
* @throws \Drupal\Core\Field\FieldException
* Throws an exception if the schema is invalid.
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0['#user']->metatag->defaultAccess()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164
public applyDefaultValue($notify = true) {@inheritdoc}
$0['#user']->metatag->applyDefaultValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:145
public preSave() {@inheritdoc}
$0['#user']->metatag->preSave()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191
public postSave($update) {@inheritdoc}
$0['#user']->metatag->postSave()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201
public delete() {@inheritdoc}
$0['#user']->metatag->delete()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209
public deleteRevision() {@inheritdoc}
$0['#user']->metatag->deleteRevision()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216
protected delegateMethod($method): array Calls a method on each FieldItem.
/**
* Calls a method on each FieldItem.
*
* Any argument passed will be forwarded to the invoked method.
*
* @param string $method
* The name of the method to be invoked.
*
* @return array
* An array of results keyed by delta.
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231
public view($display_options = array()) {@inheritdoc}
$0['#user']->metatag->view()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
public generateSampleItems($count = 1) {@inheritdoc}
$0['#user']->metatag->generateSampleItems()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253
public getConstraints() {@inheritdoc}
$0['#user']->metatag->getConstraints()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0['#user']->metatag->defaultValuesForm()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290
public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0['#user']->metatag->defaultValuesFormValidate()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308
public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0['#user']->metatag->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327
protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.
/**
* Returns the widget object used in default value form.
*
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state of the (entire) configuration form.
*
* @return \Drupal\Core\Field\WidgetInterface|null
* A Widget object or NULL if no widget is available.
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0['#user']->metatag->equals()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0['#user']->metatag->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449
public getValue() {@inheritdoc}
$0['#user']->metatag->getValue()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42
public getString() {@inheritdoc}
$0['#user']->metatag->getString()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61
public get($index) {@inheritdoc}
$0['#user']->metatag->get()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69
public set($index, $value) {@inheritdoc}
$0['#user']->metatag->set()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89
public removeItem($index) {@inheritdoc}
$0['#user']->metatag->removeItem()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:105
protected rekey($from_index = 0) Renumbers the items in the list.
/**
* Renumbers the items in the list.
*
* @param int $from_index
* Optionally, the index at which to start the renumbering, if it is known
* that items before that can safely be skipped (for example, when removing
* an item at a given index).
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:158
public first() {@inheritdoc}
$0['#user']->metatag->first()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:171
public offsetExists($offset): bool {@inheritdoc}
$0['#user']->metatag->offsetExists()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:121
public offsetUnset($offset): void {@inheritdoc}
$0['#user']->metatag->offsetUnset()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:186
public offsetGet($offset): mixed {@inheritdoc}
$0['#user']->metatag->offsetGet()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:193
public offsetSet($offset, $value): void {@inheritdoc}
$0['#user']->metatag->offsetSet()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200
public appendItem($value = null) {@inheritdoc}
$0['#user']->metatag->appendItem()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97
public getItemDefinition() {@inheritdoc}
$0['#user']->metatag->getItemDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:233
public getIterator(): ArrayIterator {@inheritdoc}
$0['#user']->metatag->getIterator()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:129
public count(): int {@inheritdoc}
$0['#user']->metatag->count()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:137
public isEmpty() {@inheritdoc}
$0['#user']->metatag->isEmpty()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113
public filter($callback) {@inheritdoc}
$0['#user']->metatag->filter()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:272
public onChange($delta) {@inheritdoc}
$0['#user']->metatag->onChange()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:294
public __clone() Magic method: Implements a deep clone.
clone $0['#user']->metatag
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:304
public last(): ?Drupal\Core\TypedData\TypedDataInterface {@inheritdoc}
$0['#user']->metatag->last()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:314
public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) Constructs a TypedData object given its definition and context.
new \Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList()
/**
* Constructs a TypedData object given its definition and context.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* The data definition.
* @param string $name
* (optional) The name of the created property, or NULL if it is the root
* of a typed data tree. Defaults to NULL.
* @param \Drupal\Core\TypedData\TypedDataInterface $parent
* (optional) The parent object of the data property, or NULL if it is the
* root of a typed data tree. Defaults to NULL.
*
* @see \Drupal\Core\TypedData\TypedDataManager::create()
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64
public getPluginId() {@inheritdoc}
$0['#user']->metatag->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0['#user']->metatag->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0['#user']->metatag->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0['#user']->metatag->validate()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
$0['#user']->metatag->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0['#user']->metatag->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0['#user']->metatag->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0['#user']->metatag->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0['#user']->metatag->getParent()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
$0['#user']->metatag->setStringTranslation()
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
$0['#user']->metatag->setTypedDataManager()
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
$0['#user']->metatag->getTypedDataManager()
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
protected ensureComputedValue() Ensures that values are only computed once.
/**
* Ensures that values are only computed once.
*/
Defined in <drupal>/modules/contrib/metatag/src/TypedData/ComputedItemListTrait.php:28
public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:339
public __construct(Drupal\Core\Language\LanguageDefault $default_language) Constructs a TranslationManager object.
/**
* Constructs a TranslationManager object.
*
* @param \Drupal\Core\Language\LanguageDefault $default_language
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:52
public addTranslator(Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator, $priority = 0): $this Appends a translation system to the translation chain.
/**
* Appends a translation system to the translation chain.
*
* @param \Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator
* The translation interface to be appended to the translation chain.
* @param int $priority
* The priority of the logger being added.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:66
protected sortTranslators(): \Drupal\Core\StringTranslation\Translator\TranslatorInterface[] Sorts translators according to priority.
/**
* Sorts translators according to priority.
*
* @return \Drupal\Core\StringTranslation\Translator\TranslatorInterface[]
* A sorted array of translator objects.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
public getStringTranslation($langcode, $string, $context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104
public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112
protected doTranslate($string, array $options = array()): string Translates a string to the current language or to a given language.
/**
* Translates a string to the current language or to a given language.
*
* @param string $string
* A string containing the English text to translate.
* @param array $options
* An associative array of additional options, with the following elements:
* - 'langcode': The language code to translate to a language other than
* what is used to display the page.
* - 'context': The context the source string belongs to.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:130
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:148
public setDefaultLangcode($langcode) Sets the default langcode.
/**
* Sets the default langcode.
*
* @param string $langcode
* A language code.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158
public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:165
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (4) "path"
protected propertyDefinitions -> array (4)
alias => Drupal\Core\TypedData\DataDefinition#10856 (2)
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
class => string (30) "\Drupal\pathauto\PathautoState"
protected typedDataManager -> null
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:47
protected getOriginalValue(): mixed Gets the data value currently stored in database.
/**
* Gets the data value currently stored in database.
*
* @return mixed
* The data value.
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:68
public setValue($value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:86
public hasValue() Returns TRUE if a value was set.
/**
* Returns TRUE if a value was set.
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:97
public persist() Persists the state.
/**
* Persists the state.
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:104
public purge() Deletes the stored state.
/**
* Deletes the stored state.
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:117
protected getCollection(): string Returns the key value collection that should be used for the given entity.
/**
* Returns the key value collection that should be used for the given entity.
*
* @return string
* The key value collection name.
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:128
public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) Constructs a TypedData object given its definition and context.
/**
* Constructs a TypedData object given its definition and context.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* The data definition.
* @param string $name
* (optional) The name of the created property, or NULL if it is the root
* of a typed data tree. Defaults to NULL.
* @param \Drupal\Core\TypedData\TypedDataInterface $parent
* (optional) The parent object of the data property, or NULL if it is the
* root of a typed data tree. Defaults to NULL.
*
* @see \Drupal\Core\TypedData\TypedDataManager::create()
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:112
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119
public validate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:138
public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\pathauto\PathautoState::bulkDelete($entity_type_id, array $pids_by_id) Deletes the URL aliases for multiple entities of the same type.
/**
* Deletes the URL aliases for multiple entities of the same type.
*
* @param string $entity_type_id
* The entity type ID of entities being deleted.
* @param int[] $pids_by_id
* A list of path IDs keyed by entity ID.
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:140
public static Drupal\pathauto\PathautoState::getPathautoStateKey($entity_id): int|string Gets the key-value store entry key for 'pathauto_state.*' collections.
/**
* Gets the key-value store entry key for 'pathauto_state.*' collections.
*
* Normally we want to use the entity ID as key for 'pathauto_state.*'
* collection entries. But some entity types may use string IDs. When such IDs
* are exceeding 128 characters, which is the limit for the 'name' column in
* the {key_value} table, the insertion of the ID in {key_value} will fail.
* Thus we test if we can use the plain ID or we need to store a hashed
* version of the entity ID. Also, it is not possible to rely on the UUID as
* entity types might not have one or might use a non-standard format.
*
* The code is inspired by
* \Drupal\Core\Cache\DatabaseBackend::normalizeCid().
*
* @param int|string $entity_id
* The entity id for which to compute the key.
*
* @return int|string
* The key used to store the value in the key-value store.
*
* @see \Drupal\Core\Cache\DatabaseBackend::normalizeCid()
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoState.php:184
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
public const Drupal\pathauto\PathautoState::SKIP :: integer 0
public const Drupal\pathauto\PathautoState::CREATE :: integer 1
public postSave($update) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoItem.php:30
public isEmpty() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoItem.php:43
public preSave() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathItem
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:61
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60
public getEntity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74
public getLangcode() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88
protected getSettings(): array Returns the array of field settings.
/**
* Returns the array of field settings.
*
* @return array
* The array of settings.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98
protected getSetting($setting_name): mixed Returns the value of a field setting.
/**
* Returns the value of a field setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111
public setValue($values, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118
/**
* {@inheritdoc}
*
* Different to the parent Map class, we avoid creating property objects as
* far as possible in order to optimize performance. Thus we just update
* $this->values if no property object has been created yet.
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186
public view($display_options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218
public deleteRevision() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228
public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233
public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240
public getValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:58
public getString() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:106
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:118
public set($property_name, $value, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:133
public getProperties($include_computed = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:165
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:178
public getIterator(): ArrayIterator Retrieves the iterator for the object.
/**
* Retrieves the iterator for the object.
*
* @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
* The iterator.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:192
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:219
public onChange($property_name, $notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*
* @param string $property_name
* The name of the property.
* @param bool $notify
* (optional) Whether to forward the notification to the parent. Defaults to
* TRUE. By passing FALSE, overrides of this method can re-use the logic
* of parent classes without triggering notification.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:236
public applyDefaultValue($notify = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:246
public getPluginId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119
public validate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\pathauto\PathautoItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoItem.php:17
public static Drupal\path\Plugin\Field\FieldType\PathItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:43
public static Drupal\path\Plugin\Field\FieldType\PathItem::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:134
public static Drupal\path\Plugin\Field\FieldType\PathItem::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:143
public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25
public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32
public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39
public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46
public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247
public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254
public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261
public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268
public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282
public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
public static Drupal\path\Plugin\Field\FieldType\PathItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:30
public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53
public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223
abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.
/**
* Defines field item properties.
*
* Properties that are required to constitute a valid, non-empty item should
* be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
*
* @return \Drupal\Core\TypedData\DataDefinitionInterface[]
* An array of property definitions of contained properties, keyed by
* property name.
*
* @see \Drupal\Core\Field\BaseFieldDefinition
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35
abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.
/**
* Returns the schema for the field.
*
* This method is static because the field schema information is needed on
* creation of the field. FieldItemInterface objects instantiated at that
* time are not reliable as field settings might be missing.
*
* Computed fields having no schema should return an empty array.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
* The field definition.
*
* @return array
* An empty array if there is no schema, or an associative array with the
* following key/value pairs:
* - columns: An array of Schema API column specifications, keyed by column
* name. The columns need to be a subset of the properties defined in
* propertyDefinitions(). The 'not null' property is ignored if present,
* as it is determined automatically by the storage controller depending
* on the table layout and the property definitions. It is recommended to
* avoid having the column definitions depend on field settings when
* possible. No assumptions should be made on how storage engines
* internally use the original column name to structure their storage.
* - unique keys: (optional) An array of Schema API unique key definitions.
* Only columns that appear in the 'columns' array are allowed.
* - indexes: (optional) An array of Schema API index definitions. Only
* columns that appear in the 'columns' array are allowed. Those indexes
* will be used as default indexes. Field definitions can specify
* additional indexes or, at their own risk, modify the default indexes
* specified by the field-type module. Some storage engines might not
* support indexes.
* - foreign keys: (optional) An array of Schema API foreign key
* definitions. Note, however, that the field data is not necessarily
* stored in SQL. Also, the possible usage is limited, as you cannot
* specify another field as related, only existing SQL tables,
* such as {taxonomy_term_data}.
*
* @throws \Drupal\Core\Field\FieldException
* Throws an exception if the schema is invalid.
*/
Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoFieldItemList.php:20
protected computeValue() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/modules/contrib/pathauto/src/PathautoFieldItemList.php:40
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0['#user']->path->defaultAccess()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathFieldItemList.php:48
public delete() {@inheritdoc}
$0['#user']->path->delete()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathFieldItemList.php:58
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44
public getEntity() {@inheritdoc}
$0['#user']->path->getEntity()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51
public setLangcode($langcode) {@inheritdoc}
$0['#user']->path->setLangcode()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60
public getLangcode() {@inheritdoc}
$0['#user']->path->getLangcode()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67
public getFieldDefinition() {@inheritdoc}
$0['#user']->path->getFieldDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74
public getSettings() {@inheritdoc}
$0['#user']->path->getSettings()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81
public getSetting($setting_name) {@inheritdoc}
$0['#user']->path->getSetting()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88
public filterEmptyItems() {@inheritdoc}
$0['#user']->path->filterEmptyItems()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95
public setValue($values, $notify = true) {@inheritdoc}
$0['#user']->path->setValue()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:50
public __get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117
public __set($property_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127
public __isset($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137
public __unset($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156
public applyDefaultValue($notify = true) {@inheritdoc}
$0['#user']->path->applyDefaultValue()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:145
public preSave() {@inheritdoc}
$0['#user']->path->preSave()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191
public postSave($update) {@inheritdoc}
$0['#user']->path->postSave()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201
public deleteRevision() {@inheritdoc}
$0['#user']->path->deleteRevision()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216
public view($display_options = array()) {@inheritdoc}
$0['#user']->path->view()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
public generateSampleItems($count = 1) {@inheritdoc}
$0['#user']->path->generateSampleItems()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253
public getConstraints() {@inheritdoc}
$0['#user']->path->getConstraints()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0['#user']->path->defaultValuesForm()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290
public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0['#user']->path->defaultValuesFormValidate()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308
public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0['#user']->path->defaultValuesFormSubmit()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327
protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.
/**
* Returns the widget object used in default value form.
*
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state of the (entire) configuration form.
*
* @return \Drupal\Core\Field\WidgetInterface|null
* A Widget object or NULL if no widget is available.
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0['#user']->path->equals()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0['#user']->path->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449
public getValue() {@inheritdoc}
$0['#user']->path->getValue()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42
public getString() {@inheritdoc}
$0['#user']->path->getString()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61
public get($index) {@inheritdoc}
$0['#user']->path->get()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69
public set($index, $value) {@inheritdoc}
$0['#user']->path->set()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89
public removeItem($index) {@inheritdoc}
$0['#user']->path->removeItem()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:105
protected rekey($from_index = 0) Renumbers the items in the list.
/**
* Renumbers the items in the list.
*
* @param int $from_index
* Optionally, the index at which to start the renumbering, if it is known
* that items before that can safely be skipped (for example, when removing
* an item at a given index).
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:158
public first() {@inheritdoc}
$0['#user']->path->first()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:171
public offsetExists($offset): bool {@inheritdoc}
$0['#user']->path->offsetExists()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:121
public offsetUnset($offset): void {@inheritdoc}
$0['#user']->path->offsetUnset()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:186
public offsetGet($offset): mixed {@inheritdoc}
$0['#user']->path->offsetGet()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:193
public offsetSet($offset, $value): void {@inheritdoc}
$0['#user']->path->offsetSet()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200
public appendItem($value = null) {@inheritdoc}
$0['#user']->path->appendItem()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97
public getItemDefinition() {@inheritdoc}
$0['#user']->path->getItemDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:233
public getIterator(): ArrayIterator {@inheritdoc}
$0['#user']->path->getIterator()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:129
public count(): int {@inheritdoc}
$0['#user']->path->count()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:137
public isEmpty() {@inheritdoc}
$0['#user']->path->isEmpty()
/**
* {@inheritdoc}
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113
public filter($callback) {@inheritdoc}
$0['#user']->path->filter()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:272
public onChange($delta) {@inheritdoc}
$0['#user']->path->onChange()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:294
public __clone() Magic method: Implements a deep clone.
clone $0['#user']->path
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:304
public last(): ?Drupal\Core\TypedData\TypedDataInterface {@inheritdoc}
$0['#user']->path->last()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:314
public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) Constructs a TypedData object given its definition and context.
new \Drupal\pathauto\PathautoFieldItemList()
/**
* Constructs a TypedData object given its definition and context.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* The data definition.
* @param string $name
* (optional) The name of the created property, or NULL if it is the root
* of a typed data tree. Defaults to NULL.
* @param \Drupal\Core\TypedData\TypedDataInterface $parent
* (optional) The parent object of the data property, or NULL if it is the
* root of a typed data tree. Defaults to NULL.
*
* @see \Drupal\Core\TypedData\TypedDataManager::create()
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64
public getPluginId() {@inheritdoc}
$0['#user']->path->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0['#user']->path->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0['#user']->path->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0['#user']->path->validate()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
$0['#user']->path->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0['#user']->path->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0['#user']->path->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0['#user']->path->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0['#user']->path->getParent()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
$0['#user']->path->setStringTranslation()
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
$0['#user']->path->setTypedDataManager()
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
$0['#user']->path->getTypedDataManager()
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
protected ensureComputedValue() Ensures that values are only computed once.
/**
* Ensures that values are only computed once.
*/
Inherited from Drupal\path\Plugin\Field\FieldType\PathFieldItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:32
public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:339
public __construct(array $values, $entity_type = 'field_config') Constructs a FieldConfig object.
/**
* Constructs a FieldConfig object.
*
* In most cases, Field entities are created via
* FieldConfig::create($values), where $values is the same
* parameter as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. The
* storage associated with the field can be specified either with:
* - field_storage: the FieldStorageConfigInterface object,
* or by referring to an existing field storage in the current configuration
* with:
* - field_name: The field name.
* - entity_type: The entity type.
* Additionally, a 'bundle' property is required to indicate the entity
* bundle to which the field is attached to. Other array elements will be
* used to set the corresponding properties on the class; see the class
* property documentation for details.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:110
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:143
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\EntityBase::preSave().
/**
* Overrides \Drupal\Core\Entity\EntityBase::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:165
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:201
protected linkTemplates() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:264
protected urlRouteParameters($rel) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:280
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:291
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:298
public isDisplayConfigurable($context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:332
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:339
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:347
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:354
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:361
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:200
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:207
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:214
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:221
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:228
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:262
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:310
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:324
public setLabel($label) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:332
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:340
public setDescription($description) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:348
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:356
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:365
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:373
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:381
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:389
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:401
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:409
public setRequired($required) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:417
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:425
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:442
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:450
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:458
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465
public __sleep(): array Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
*
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578
public setConstraints(array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593
public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601
public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629
public getOriginalId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127
public setOriginalId($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:134
public isNew() Overrides EntityBase::isNew().
/**
* Overrides EntityBase::isNew().
*
* EntityInterface::enforceIsNew() is only supported for newly created
* configuration entities but has no effect after saving, since each
* configuration entity is unique.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158
public set($property_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:166
public enable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:184
public disable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:192
public setStatus($status) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:200
public status() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:208
public setUninstalling($uninstalling) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:215
public isUninstalling() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:222
public createDuplicate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:254
protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/**
* Gets the typed config manager.
*
* @return \Drupal\Core\Config\TypedConfigManagerInterface
* The typed configuration plugin manager.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:290
public toUrl($rel = null, array $options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:408
public getCacheTagsToInvalidate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:417
/**
* Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
*
* Note that this function should only be called from implementations of
* \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
* as dependencies are recalculated during every entity save.
*
* @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:432
public getDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:446
public getConfigDependencyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:460
public getConfigTarget() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:467
/**
* {@inheritdoc}
*
* Override to never invalidate the entity's cache tag; the config system
* already invalidates it.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509
public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:531
public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:539
public getThirdPartySettings($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:551
public unsetThirdPartySetting($module, $key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:558
public getThirdPartyProviders() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:571
public isInstallable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612
public trustData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:619
public hasTrustedData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:627
public save() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:634
protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/**
* Gets the entity type manager.
*
* @return \Drupal\Core\Entity\EntityTypeManagerInterface
* The entity type manager.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85
protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/**
* Gets the entity type bundle info service.
*
* @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
* The entity type bundle info service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95
protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/**
* Gets the language manager.
*
* @return \Drupal\Core\Language\LanguageManagerInterface
* The language manager service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105
protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/**
* Gets the UUID generator.
*
* @return \Drupal\Component\Uuid\UuidInterface
* The UUID service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115
public uuid() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:129
public enforceIsNew($value = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
public getEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152
public bundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159
public label() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:166
public hasLinkTemplate($rel) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271
public uriRelationships() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315
public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:337
public language() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:351
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376
public getEntityType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408
public referencedEntities() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:466
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473
protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/**
* The list cache tags to invalidate for this entity.
*
* @return string[]
* Set of list cache tags.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517
public getTypedData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628
public getConfigDependencyKey() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673
public getOriginal(): ?static {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696
public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:711
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:722
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:734
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:745
public addCacheableDependency($other_object) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
public addCacheContexts(array $cache_contexts) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32
public addCacheTags(array $cache_tags) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42
public mergeCacheMaxAge($max_age) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52
protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/**
* Sets cacheability; useful for value object constructors.
*
* @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
* The cacheability to set.
*
* @return $this
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
public traitSleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/**
* Calculates and returns dependencies of a specific plugin instance.
*
* Dependencies are added for the module that provides the plugin, as well
* as any dependencies declared by the instance's calculateDependencies()
* method, if it implements
* \Drupal\Component\Plugin\DependentPluginInterface.
*
* @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
* The plugin instance.
*
* @return array
* An array of dependencies keyed by the type of dependency.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/**
* Calculates and adds dependencies of a specific plugin instance.
*
* Dependencies are added for the module that provides the plugin, as well
* as any dependencies declared by the instance's calculateDependencies()
* method, if it implements
* \Drupal\Component\Plugin\DependentPluginInterface.
*
* @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
* The plugin instance.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/**
* Wraps the module handler.
*
* @return \Drupal\Core\Extension\ModuleHandlerInterface
* The module handler.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/**
* Wraps the theme handler.
*
* @return \Drupal\Core\Extension\ThemeHandlerInterface
* The theme handler.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
protected addDependencyTrait($type, $name): $this Adds a dependency.
/**
* Adds a dependency.
*
* @param string $type
* Type of dependency being added: 'module', 'theme', 'config', 'content'.
* @param string $name
* If $type is 'module' or 'theme', the name of the module or theme. If
* $type is 'config' or 'content', the result of
* EntityInterface::getConfigDependencyName().
*
* @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
*
* @return $this
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
/**
* Adds multiple dependencies.
*
* @param array $dependencies
* An array of dependencies keyed by the type of dependency. One example:
* @code
* [
* 'module' => [
* 'node',
* 'field',
* 'image',
* ],
* ];
* @endcode
*
* @see \Drupal\Core\Entity\DependencyTrait::addDependency
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
public setSyncing($syncing) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
public isSyncing() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/**
* Returns the typed data class name for this entity.
*
* @return string
* The string representing the typed data class name.
*
* @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644
public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:211
public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:237
public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and field name.
/**
* Loads a field config entity based on the entity type and field name.
*
* @param string $entity_type_id
* ID of the entity type.
* @param string $bundle
* Bundle name.
* @param string $field_name
* Name of the field.
*
* @return \Drupal\field\FieldConfigInterface|null
* The field config entity if one exists for the provided field
* name, otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:379
public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491
public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500
public static Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Callback for uasort() to sort configuration entities by weight and label.
/**
* Callback for uasort() to sort configuration entities by weight and label.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:240
/**
* {@inheritdoc}
*
* Override to never invalidate the individual entities' cache tags; the
* config system already invalidates them.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:519
protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/**
* Gets the configuration manager.
*
* @return \Drupal\Core\Config\ConfigManager
* The configuration manager.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605
public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:435
public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:460
public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:524
public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:534
public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:544
protected static Drupal\Core\Field\FieldConfigBase::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:295
public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:578
public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:453
public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:447
protected static Drupal\Core\Entity\EntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.
/**
* Invalidates an entity's cache tags upon delete.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityInterface[] $entities
* An array of entities.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0['#user']->field_metatag->defaultAccess()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164
public applyDefaultValue($notify = true) {@inheritdoc}
$0['#user']->field_metatag->applyDefaultValue()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172
public preSave() {@inheritdoc}
$0['#user']->field_metatag->preSave()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191
public postSave($update) {@inheritdoc}
$0['#user']->field_metatag->postSave()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201
public delete() {@inheritdoc}
$0['#user']->field_metatag->delete()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209
public deleteRevision() {@inheritdoc}
$0['#user']->field_metatag->deleteRevision()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216
protected delegateMethod($method): array Calls a method on each FieldItem.
/**
* Calls a method on each FieldItem.
*
* Any argument passed will be forwarded to the invoked method.
*
* @param string $method
* The name of the method to be invoked.
*
* @return array
* An array of results keyed by delta.
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231
public view($display_options = array()) {@inheritdoc}
$0['#user']->field_metatag->view()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
public generateSampleItems($count = 1) {@inheritdoc}
$0['#user']->field_metatag->generateSampleItems()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253
public getConstraints() {@inheritdoc}
$0['#user']->field_metatag->getConstraints()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265
public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
$0['#user']->field_metatag->defaultValuesForm()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290
public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327
protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.
/**
* Returns the widget object used in default value form.
*
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state of the (entire) configuration form.
*
* @return \Drupal\Core\Field\WidgetInterface|null
* A Widget object or NULL if no widget is available.
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0['#user']->field_metatag->equals()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
public getValue() {@inheritdoc}
$0['#user']->field_metatag->getValue()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:45
public getString() {@inheritdoc}
$0['#user']->field_metatag->getString()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:94
public get($index) {@inheritdoc}
$0['#user']->field_metatag->get()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:106
public set($index, $value) {@inheritdoc}
$0['#user']->field_metatag->set()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:116
public removeItem($index) {@inheritdoc}
$0['#user']->field_metatag->removeItem()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:138
protected rekey($from_index = 0) Renumbers the items in the list.
/**
* Renumbers the items in the list.
*
* @param int $from_index
* Optionally, the index at which to start the renumbering, if it is known
* that items before that can safely be skipped (for example, when removing
* an item at a given index).
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:158
public first() {@inheritdoc}
$0['#user']->field_metatag->first()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:171
public offsetExists($offset): bool {@inheritdoc}
$0['#user']->field_metatag->offsetExists()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:178
public offsetUnset($offset): void {@inheritdoc}
$0['#user']->field_metatag->offsetUnset()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:186
public offsetGet($offset): mixed {@inheritdoc}
$0['#user']->field_metatag->offsetGet()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:193
public offsetSet($offset, $value): void {@inheritdoc}
$0['#user']->field_metatag->offsetSet()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200
public appendItem($value = null) {@inheritdoc}
$0['#user']->field_metatag->appendItem()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:213
public getItemDefinition() {@inheritdoc}
$0['#user']->field_metatag->getItemDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:233
public getIterator(): ArrayIterator {@inheritdoc}
$0['#user']->field_metatag->getIterator()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:240
public count(): int {@inheritdoc}
$0['#user']->field_metatag->count()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:247
public isEmpty() {@inheritdoc}
$0['#user']->field_metatag->isEmpty()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:254
public filter($callback) {@inheritdoc}
$0['#user']->field_metatag->filter()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:272
public onChange($delta) {@inheritdoc}
$0['#user']->field_metatag->onChange()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:294
public __clone() Magic method: Implements a deep clone.
clone $0['#user']->field_metatag
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:304
public last(): ?Drupal\Core\TypedData\TypedDataInterface {@inheritdoc}
$0['#user']->field_metatag->last()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:314
public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) Constructs a TypedData object given its definition and context.
new \Drupal\metatag\Plugin\Field\FieldType\MetatagFieldItemList()
/**
* Constructs a TypedData object given its definition and context.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* The data definition.
* @param string $name
* (optional) The name of the created property, or NULL if it is the root
* of a typed data tree. Defaults to NULL.
* @param \Drupal\Core\TypedData\TypedDataInterface $parent
* (optional) The parent object of the data property, or NULL if it is the
* root of a typed data tree. Defaults to NULL.
*
* @see \Drupal\Core\TypedData\TypedDataManager::create()
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64
public getPluginId() {@inheritdoc}
$0['#user']->field_metatag->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0['#user']->field_metatag->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0['#user']->field_metatag->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0['#user']->field_metatag->validate()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
$0['#user']->field_metatag->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0['#user']->field_metatag->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0['#user']->field_metatag->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0['#user']->field_metatag->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0['#user']->field_metatag->getParent()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
$0['#user']->field_metatag->setTypedDataManager()
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
$0['#user']->field_metatag->getTypedDataManager()
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:339
protected description -> string (76) "Please provide the name of the person who has referred you to CounsellingBC."
protected settings -> array (2)
handler => string (12) "default:user"
handler_settings => array (5)
target_bundles => null
sort => array (2)
field => string (4) "name"
direction => string (3) "ASC"
auto_create => boolean false
filter => array (1)
type => string (5) "_none"
include_anonymous => boolean false
protected required -> boolean false
protected translatable -> boolean false
protected default_value -> array (0)
protected default_value_callback -> string (0) ""
protected fieldStorage -> null
protected itemDefinition -> null
protected constraints -> array (0)
protected propertyConstraints -> array (0)
protected deleted -> boolean false
public __construct(array $values, $entity_type = 'field_config') Constructs a FieldConfig object.
/**
* Constructs a FieldConfig object.
*
* In most cases, Field entities are created via
* FieldConfig::create($values), where $values is the same
* parameter as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. The
* storage associated with the field can be specified either with:
* - field_storage: the FieldStorageConfigInterface object,
* or by referring to an existing field storage in the current configuration
* with:
* - field_name: The field name.
* - entity_type: The entity type.
* Additionally, a 'bundle' property is required to indicate the entity
* bundle to which the field is attached to. Other array elements will be
* used to set the corresponding properties on the class; see the class
* property documentation for details.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:110
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:143
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\EntityBase::preSave().
/**
* Overrides \Drupal\Core\Entity\EntityBase::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:165
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:201
protected linkTemplates() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:264
protected urlRouteParameters($rel) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:280
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:291
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:298
public isDisplayConfigurable($context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:332
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:339
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:347
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:354
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:361
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:200
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:207
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:214
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:221
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:228
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:262
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:310
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:324
public setLabel($label) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:332
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:340
public setDescription($description) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:348
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:356
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:365
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:373
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:381
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:389
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:401
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:409
public setRequired($required) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:417
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:425
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:442
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:450
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:458
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465
public __sleep(): array Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
*
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578
public setConstraints(array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593
public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601
public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629
public getOriginalId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127
public setOriginalId($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:134
public isNew() Overrides EntityBase::isNew().
/**
* Overrides EntityBase::isNew().
*
* EntityInterface::enforceIsNew() is only supported for newly created
* configuration entities but has no effect after saving, since each
* configuration entity is unique.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158
public set($property_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:166
public enable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:184
public disable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:192
public setStatus($status) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:200
public status() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:208
public setUninstalling($uninstalling) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:215
public isUninstalling() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:222
public createDuplicate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:254
protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/**
* Gets the typed config manager.
*
* @return \Drupal\Core\Config\TypedConfigManagerInterface
* The typed configuration plugin manager.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:290
public toUrl($rel = null, array $options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:408
public getCacheTagsToInvalidate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:417
/**
* Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
*
* Note that this function should only be called from implementations of
* \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
* as dependencies are recalculated during every entity save.
*
* @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:432
public getDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:446
public getConfigDependencyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:460
public getConfigTarget() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:467
/**
* {@inheritdoc}
*
* Override to never invalidate the entity's cache tag; the config system
* already invalidates it.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509
public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:531
public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:539
public getThirdPartySettings($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:551
public unsetThirdPartySetting($module, $key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:558
public getThirdPartyProviders() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:571
public isInstallable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612
public trustData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:619
public hasTrustedData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:627
public save() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:634
protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/**
* Gets the entity type manager.
*
* @return \Drupal\Core\Entity\EntityTypeManagerInterface
* The entity type manager.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85
protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/**
* Gets the entity type bundle info service.
*
* @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
* The entity type bundle info service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95
protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/**
* Gets the language manager.
*
* @return \Drupal\Core\Language\LanguageManagerInterface
* The language manager service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105
protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/**
* Gets the UUID generator.
*
* @return \Drupal\Component\Uuid\UuidInterface
* The UUID service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115
public uuid() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:129
public enforceIsNew($value = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
public getEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152
public bundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159
public label() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:166
public hasLinkTemplate($rel) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271
public uriRelationships() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315
public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:337
public language() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:351
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376
public getEntityType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408
public referencedEntities() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:466
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473
protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/**
* The list cache tags to invalidate for this entity.
*
* @return string[]
* Set of list cache tags.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517
public getTypedData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628
public getConfigDependencyKey() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673
public getOriginal(): ?static {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696
public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:711
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:722
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:734
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:745
public addCacheableDependency($other_object) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
public addCacheContexts(array $cache_contexts) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32
public addCacheTags(array $cache_tags) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42
public mergeCacheMaxAge($max_age) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52
protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/**
* Sets cacheability; useful for value object constructors.
*
* @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
* The cacheability to set.
*
* @return $this
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
public traitSleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/**
* Calculates and returns dependencies of a specific plugin instance.
*
* Dependencies are added for the module that provides the plugin, as well
* as any dependencies declared by the instance's calculateDependencies()
* method, if it implements
* \Drupal\Component\Plugin\DependentPluginInterface.
*
* @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
* The plugin instance.
*
* @return array
* An array of dependencies keyed by the type of dependency.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/**
* Calculates and adds dependencies of a specific plugin instance.
*
* Dependencies are added for the module that provides the plugin, as well
* as any dependencies declared by the instance's calculateDependencies()
* method, if it implements
* \Drupal\Component\Plugin\DependentPluginInterface.
*
* @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
* The plugin instance.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/**
* Wraps the module handler.
*
* @return \Drupal\Core\Extension\ModuleHandlerInterface
* The module handler.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/**
* Wraps the theme handler.
*
* @return \Drupal\Core\Extension\ThemeHandlerInterface
* The theme handler.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
protected addDependencyTrait($type, $name): $this Adds a dependency.
/**
* Adds a dependency.
*
* @param string $type
* Type of dependency being added: 'module', 'theme', 'config', 'content'.
* @param string $name
* If $type is 'module' or 'theme', the name of the module or theme. If
* $type is 'config' or 'content', the result of
* EntityInterface::getConfigDependencyName().
*
* @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
*
* @return $this
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
/**
* Adds multiple dependencies.
*
* @param array $dependencies
* An array of dependencies keyed by the type of dependency. One example:
* @code
* [
* 'module' => [
* 'node',
* 'field',
* 'image',
* ],
* ];
* @endcode
*
* @see \Drupal\Core\Entity\DependencyTrait::addDependency
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
public setSyncing($syncing) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
public isSyncing() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/**
* Returns the typed data class name for this entity.
*
* @return string
* The string representing the typed data class name.
*
* @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644
public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:211
public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:237
public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and field name.
/**
* Loads a field config entity based on the entity type and field name.
*
* @param string $entity_type_id
* ID of the entity type.
* @param string $bundle
* Bundle name.
* @param string $field_name
* Name of the field.
*
* @return \Drupal\field\FieldConfigInterface|null
* The field config entity if one exists for the provided field
* name, otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:379
public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491
public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500
public static Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Callback for uasort() to sort configuration entities by weight and label.
/**
* Callback for uasort() to sort configuration entities by weight and label.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:240
/**
* {@inheritdoc}
*
* Override to never invalidate the individual entities' cache tags; the
* config system already invalidates them.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:519
protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/**
* Gets the configuration manager.
*
* @return \Drupal\Core\Config\ConfigManager
* The configuration manager.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605
public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:435
public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:460
public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:524
public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:534
public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:544
protected static Drupal\Core\Field\FieldConfigBase::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:295
public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:578
public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:453
public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:447
protected static Drupal\Core\Entity\EntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.
/**
* Invalidates an entity's cache tags upon delete.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityInterface[] $entities
* An array of entities.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582
protected name -> string (22) "field_user_referred_by"
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216
protected delegateMethod($method): array Calls a method on each FieldItem.
/**
* Calls a method on each FieldItem.
*
* Any argument passed will be forwarded to the invoked method.
*
* @param string $method
* The name of the method to be invoked.
*
* @return array
* An array of results keyed by delta.
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231
public view($display_options = array()) {@inheritdoc}
$0['#user']->field_user_referred_by->view()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
public generateSampleItems($count = 1) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308
protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.
/**
* Returns the widget object used in default value form.
*
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state of the (entire) configuration form.
*
* @return \Drupal\Core\Field\WidgetInterface|null
* A Widget object or NULL if no widget is available.
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0['#user']->field_user_referred_by->equals()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449
public getValue() {@inheritdoc}
$0['#user']->field_user_referred_by->getValue()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:45
public getString() {@inheritdoc}
$0['#user']->field_user_referred_by->getString()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:94
public get($index) {@inheritdoc}
$0['#user']->field_user_referred_by->get()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:106
public set($index, $value) {@inheritdoc}
$0['#user']->field_user_referred_by->set()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:116
public removeItem($index) {@inheritdoc}
$0['#user']->field_user_referred_by->removeItem()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:138
protected rekey($from_index = 0) Renumbers the items in the list.
/**
* Renumbers the items in the list.
*
* @param int $from_index
* Optionally, the index at which to start the renumbering, if it is known
* that items before that can safely be skipped (for example, when removing
* an item at a given index).
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:158
public first() {@inheritdoc}
$0['#user']->field_user_referred_by->first()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:171
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:178
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:186
public offsetGet($offset): mixed {@inheritdoc}
$0['#user']->field_user_referred_by->offsetGet()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:193
public offsetSet($offset, $value): void {@inheritdoc}
$0['#user']->field_user_referred_by->offsetSet()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200
public appendItem($value = null) {@inheritdoc}
$0['#user']->field_user_referred_by->appendItem()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:213
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:233
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:240
public count(): int {@inheritdoc}
$0['#user']->field_user_referred_by->count()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:247
public isEmpty() {@inheritdoc}
$0['#user']->field_user_referred_by->isEmpty()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:254
public filter($callback) {@inheritdoc}
$0['#user']->field_user_referred_by->filter()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:272
public onChange($delta) {@inheritdoc}
$0['#user']->field_user_referred_by->onChange()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:294
public __clone() Magic method: Implements a deep clone.
clone $0['#user']->field_user_referred_by
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:304
public last(): ?Drupal\Core\TypedData\TypedDataInterface {@inheritdoc}
$0['#user']->field_user_referred_by->last()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:314
public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) Constructs a TypedData object given its definition and context.
new \Drupal\Core\Field\EntityReferenceFieldItemList()
/**
* Constructs a TypedData object given its definition and context.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* The data definition.
* @param string $name
* (optional) The name of the created property, or NULL if it is the root
* of a typed data tree. Defaults to NULL.
* @param \Drupal\Core\TypedData\TypedDataInterface $parent
* (optional) The parent object of the data property, or NULL if it is the
* root of a typed data tree. Defaults to NULL.
*
* @see \Drupal\Core\TypedData\TypedDataManager::create()
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0['#user']->field_user_referred_by->getParent()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\EntityReferenceFieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:62
public __construct(array $values, $entity_type = 'field_config') Constructs a FieldConfig object.
/**
* Constructs a FieldConfig object.
*
* In most cases, Field entities are created via
* FieldConfig::create($values), where $values is the same
* parameter as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. The
* storage associated with the field can be specified either with:
* - field_storage: the FieldStorageConfigInterface object,
* or by referring to an existing field storage in the current configuration
* with:
* - field_name: The field name.
* - entity_type: The entity type.
* Additionally, a 'bundle' property is required to indicate the entity
* bundle to which the field is attached to. Other array elements will be
* used to set the corresponding properties on the class; see the class
* property documentation for details.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:110
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:143
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\EntityBase::preSave().
/**
* Overrides \Drupal\Core\Entity\EntityBase::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:165
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:201
protected linkTemplates() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:264
protected urlRouteParameters($rel) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:280
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:291
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:298
public isDisplayConfigurable($context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:332
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:339
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:347
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:354
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:361
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:200
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:207
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:214
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:221
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:228
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:262
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:310
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:324
public setLabel($label) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:332
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:340
public setDescription($description) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:348
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:356
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:365
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:373
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:381
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:389
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:401
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:409
public setRequired($required) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:417
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:425
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:442
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:450
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:458
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465
public __sleep(): array Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
*
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578
public setConstraints(array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593
public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601
public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629
public getOriginalId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127
public setOriginalId($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:134
public isNew() Overrides EntityBase::isNew().
/**
* Overrides EntityBase::isNew().
*
* EntityInterface::enforceIsNew() is only supported for newly created
* configuration entities but has no effect after saving, since each
* configuration entity is unique.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158
public set($property_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:166
public enable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:184
public disable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:192
public setStatus($status) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:200
public status() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:208
public setUninstalling($uninstalling) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:215
public isUninstalling() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:222
public createDuplicate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:254
protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/**
* Gets the typed config manager.
*
* @return \Drupal\Core\Config\TypedConfigManagerInterface
* The typed configuration plugin manager.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:290
public toUrl($rel = null, array $options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:408
public getCacheTagsToInvalidate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:417
/**
* Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
*
* Note that this function should only be called from implementations of
* \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
* as dependencies are recalculated during every entity save.
*
* @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:432
public getDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:446
public getConfigDependencyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:460
public getConfigTarget() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:467
/**
* {@inheritdoc}
*
* Override to never invalidate the entity's cache tag; the config system
* already invalidates it.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509
public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:531
public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:539
public getThirdPartySettings($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:551
public unsetThirdPartySetting($module, $key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:558
public getThirdPartyProviders() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:571
public isInstallable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612
public trustData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:619
public hasTrustedData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:627
public save() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:634
protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/**
* Gets the entity type manager.
*
* @return \Drupal\Core\Entity\EntityTypeManagerInterface
* The entity type manager.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85
protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/**
* Gets the entity type bundle info service.
*
* @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
* The entity type bundle info service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95
protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/**
* Gets the language manager.
*
* @return \Drupal\Core\Language\LanguageManagerInterface
* The language manager service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105
protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/**
* Gets the UUID generator.
*
* @return \Drupal\Component\Uuid\UuidInterface
* The UUID service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115
public uuid() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:129
public enforceIsNew($value = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
public getEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152
public bundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159
public label() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:166
public hasLinkTemplate($rel) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271
public uriRelationships() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315
public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:337
public language() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:351
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376
public getEntityType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408
public referencedEntities() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:466
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473
protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/**
* The list cache tags to invalidate for this entity.
*
* @return string[]
* Set of list cache tags.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517
public getTypedData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628
public getConfigDependencyKey() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673
public getOriginal(): ?static {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696
public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:711
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:722
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:734
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:745
public addCacheableDependency($other_object) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
public addCacheContexts(array $cache_contexts) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32
public addCacheTags(array $cache_tags) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42
public mergeCacheMaxAge($max_age) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52
protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/**
* Sets cacheability; useful for value object constructors.
*
* @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
* The cacheability to set.
*
* @return $this
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
public traitSleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/**
* Calculates and returns dependencies of a specific plugin instance.
*
* Dependencies are added for the module that provides the plugin, as well
* as any dependencies declared by the instance's calculateDependencies()
* method, if it implements
* \Drupal\Component\Plugin\DependentPluginInterface.
*
* @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
* The plugin instance.
*
* @return array
* An array of dependencies keyed by the type of dependency.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/**
* Calculates and adds dependencies of a specific plugin instance.
*
* Dependencies are added for the module that provides the plugin, as well
* as any dependencies declared by the instance's calculateDependencies()
* method, if it implements
* \Drupal\Component\Plugin\DependentPluginInterface.
*
* @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
* The plugin instance.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/**
* Wraps the module handler.
*
* @return \Drupal\Core\Extension\ModuleHandlerInterface
* The module handler.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/**
* Wraps the theme handler.
*
* @return \Drupal\Core\Extension\ThemeHandlerInterface
* The theme handler.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
protected addDependencyTrait($type, $name): $this Adds a dependency.
/**
* Adds a dependency.
*
* @param string $type
* Type of dependency being added: 'module', 'theme', 'config', 'content'.
* @param string $name
* If $type is 'module' or 'theme', the name of the module or theme. If
* $type is 'config' or 'content', the result of
* EntityInterface::getConfigDependencyName().
*
* @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
*
* @return $this
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
/**
* Adds multiple dependencies.
*
* @param array $dependencies
* An array of dependencies keyed by the type of dependency. One example:
* @code
* [
* 'module' => [
* 'node',
* 'field',
* 'image',
* ],
* ];
* @endcode
*
* @see \Drupal\Core\Entity\DependencyTrait::addDependency
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
public setSyncing($syncing) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
public isSyncing() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/**
* Returns the typed data class name for this entity.
*
* @return string
* The string representing the typed data class name.
*
* @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644
public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:211
public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:237
public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and field name.
/**
* Loads a field config entity based on the entity type and field name.
*
* @param string $entity_type_id
* ID of the entity type.
* @param string $bundle
* Bundle name.
* @param string $field_name
* Name of the field.
*
* @return \Drupal\field\FieldConfigInterface|null
* The field config entity if one exists for the provided field
* name, otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:379
public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491
public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500
public static Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Callback for uasort() to sort configuration entities by weight and label.
/**
* Callback for uasort() to sort configuration entities by weight and label.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:240
/**
* {@inheritdoc}
*
* Override to never invalidate the individual entities' cache tags; the
* config system already invalidates them.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:519
protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/**
* Gets the configuration manager.
*
* @return \Drupal\Core\Config\ConfigManager
* The configuration manager.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605
public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:435
public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:460
public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:524
public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:534
public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:544
protected static Drupal\Core\Field\FieldConfigBase::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:295
public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:578
public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:453
public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:447
protected static Drupal\Core\Entity\EntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.
/**
* Invalidates an entity's cache tags upon delete.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityInterface[] $entities
* An array of entities.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156
public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}
$0['#user']->user_picture->defaultAccess()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164
public applyDefaultValue($notify = true) {@inheritdoc}
$0['#user']->user_picture->applyDefaultValue()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172
public preSave() {@inheritdoc}
$0['#user']->user_picture->preSave()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191
protected delegateMethod($method): array Calls a method on each FieldItem.
/**
* Calls a method on each FieldItem.
*
* Any argument passed will be forwarded to the invoked method.
*
* @param string $method
* The name of the method to be invoked.
*
* @return array
* An array of results keyed by delta.
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231
public view($display_options = array()) {@inheritdoc}
$0['#user']->user_picture->view()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
public generateSampleItems($count = 1) {@inheritdoc}
$0['#user']->user_picture->generateSampleItems()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253
public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308
protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.
/**
* Returns the widget object used in default value form.
*
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state of the (entire) configuration form.
*
* @return \Drupal\Core\Field\WidgetInterface|null
* A Widget object or NULL if no widget is available.
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}
$0['#user']->user_picture->equals()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}
$0['#user']->user_picture->hasAffectingChanges()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449
public getValue() {@inheritdoc}
$0['#user']->user_picture->getValue()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:45
public getString() {@inheritdoc}
$0['#user']->user_picture->getString()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:94
public get($index) {@inheritdoc}
$0['#user']->user_picture->get()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:106
public set($index, $value) {@inheritdoc}
$0['#user']->user_picture->set()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:116
public removeItem($index) {@inheritdoc}
$0['#user']->user_picture->removeItem()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:138
protected rekey($from_index = 0) Renumbers the items in the list.
/**
* Renumbers the items in the list.
*
* @param int $from_index
* Optionally, the index at which to start the renumbering, if it is known
* that items before that can safely be skipped (for example, when removing
* an item at a given index).
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:158
public first() {@inheritdoc}
$0['#user']->user_picture->first()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:171
public offsetExists($offset): bool {@inheritdoc}
$0['#user']->user_picture->offsetExists()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:178
public offsetUnset($offset): void {@inheritdoc}
$0['#user']->user_picture->offsetUnset()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:186
public offsetGet($offset): mixed {@inheritdoc}
$0['#user']->user_picture->offsetGet()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:193
public offsetSet($offset, $value): void {@inheritdoc}
$0['#user']->user_picture->offsetSet()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200
public appendItem($value = null) {@inheritdoc}
$0['#user']->user_picture->appendItem()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:213
public getItemDefinition() {@inheritdoc}
$0['#user']->user_picture->getItemDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:233
public getIterator(): ArrayIterator {@inheritdoc}
$0['#user']->user_picture->getIterator()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:240
public count(): int {@inheritdoc}
$0['#user']->user_picture->count()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:247
public isEmpty() {@inheritdoc}
$0['#user']->user_picture->isEmpty()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:254
public filter($callback) {@inheritdoc}
$0['#user']->user_picture->filter()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:272
public onChange($delta) {@inheritdoc}
$0['#user']->user_picture->onChange()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:294
public __clone() Magic method: Implements a deep clone.
clone $0['#user']->user_picture
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:304
public last(): ?Drupal\Core\TypedData\TypedDataInterface {@inheritdoc}
$0['#user']->user_picture->last()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:314
public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) Constructs a TypedData object given its definition and context.
new \Drupal\file\Plugin\Field\FieldType\FileFieldItemList()
/**
* Constructs a TypedData object given its definition and context.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* The data definition.
* @param string $name
* (optional) The name of the created property, or NULL if it is the root
* of a typed data tree. Defaults to NULL.
* @param \Drupal\Core\TypedData\TypedDataInterface $parent
* (optional) The parent object of the data property, or NULL if it is the
* root of a typed data tree. Defaults to NULL.
*
* @see \Drupal\Core\TypedData\TypedDataManager::create()
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64
public getPluginId() {@inheritdoc}
$0['#user']->user_picture->getPluginId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
public getPluginDefinition() {@inheritdoc}
$0['#user']->user_picture->getPluginDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
public getDataDefinition() {@inheritdoc}
$0['#user']->user_picture->getDataDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
public validate() {@inheritdoc}
$0['#user']->user_picture->validate()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131
public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
$0['#user']->user_picture->setContext()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
public getName() {@inheritdoc}
$0['#user']->user_picture->getName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
public getRoot() {@inheritdoc}
$0['#user']->user_picture->getRoot()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
public getPropertyPath() {@inheritdoc}
$0['#user']->user_picture->getPropertyPath()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
public getParent() {@inheritdoc}
$0['#user']->user_picture->getParent()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
$0['#user']->user_picture->setStringTranslation()
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
$0['#user']->user_picture->setTypedDataManager()
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
$0['#user']->user_picture->getTypedDataManager()
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\EntityReferenceFieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:62
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (7) "integer"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (4) "uuid"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (23) "The user language code."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (8) "language"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
protected string -> string (23) "Preferred language code"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (77) "The user's preferred language code for receiving emails and viewing the site."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (77) "The user's preferred language code for receiving emails and viewing the site."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (8) "language"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
protected string -> string (29) "Preferred admin language code"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (68) "The user's preferred language code for viewing administration pages."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (68) "The user's preferred language code for viewing administration pages."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (8) "language"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
name => Drupal\Core\Field\BaseFieldDefinition#1816 (7)
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (22) "The name of this user."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (6) "string"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (35) "The password of this user (hashed)."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (35) "The password of this user (hashed)."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (8) "password"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
mail => Drupal\Core\Field\BaseFieldDefinition#1824 (7)
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (23) "The email of this user."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (5) "email"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (26) "The timezone of this user."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (26) "The timezone of this user."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (6) "string"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
status => Drupal\Core\Field\BaseFieldDefinition#1832 (7)
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (38) "Whether the user is active or blocked."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (38) "Whether the user is active or blocked."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (7) "boolean"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
created => Drupal\Core\Field\BaseFieldDefinition#1838 (7)
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (35) "The time that the user was created."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (35) "The time that the user was created."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (7) "created"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (39) "The time that the user was last edited."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (39) "The time that the user was last edited."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (7) "changed"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (46) "The time that the user last accessed the site."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (46) "The time that the user last accessed the site."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (9) "timestamp"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (38) "The time that the user last logged in."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (38) "The time that the user last logged in."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (9) "timestamp"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (52) "The email address used for initial account creation."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (52) "The email address used for initial account creation."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (5) "email"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (23) "The roles the user has."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataReferenceTargetDefinition.php:22
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:69
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:100
public getEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:119
public setEntityTypeId($entity_type_id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:126
public getBundles() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:133
public setBundles(?array $bundles = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:141
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ComplexDataDefinitionBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php:25
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ComplexDataDefinitionBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php:35
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ComplexDataDefinitionBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php:42
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Entity\TypedData\EntityDataDefinition::create($entity_type_id = null, $bundle = null): static Creates a new entity definition.
/**
* Creates a new entity definition.
*
* @param string $entity_type_id
* (optional) The ID of the entity type, or NULL if the entity type is
* unknown. Defaults to NULL.
* @param string $bundle
* (optional) The bundle of the entity type, or NULL if the bundle is
* unknown. Defaults to NULL.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:24
public static Drupal\Core\Entity\TypedData\EntityDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:58
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public getTargetDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataReferenceDefinition.php:48
public setTargetDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the definition of the referenced data.
/**
* Sets the definition of the referenced data.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* The target definition to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataReferenceDefinition.php:60
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\TypedData\DataReferenceDefinition::create($target_data_type): static Creates a new data reference definition.
/**
* Creates a new data reference definition.
*
* @param string $target_data_type
* The data type of the referenced data.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataReferenceDefinition.php:28
public static Drupal\Core\TypedData\DataReferenceDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataReferenceDefinition.php:37
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
protected string -> string (58) "A flag indicating whether this is the default translation."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (58) "A flag indicating whether this is the default translation."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (7) "boolean"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
protected string -> string (40) "Metatags (Hidden field for JSON support)"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
label string (40) "Metatags (Hidden field for JSON support)"
protected string -> string (38) "The computed meta tags for the entity."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (38) "The computed meta tags for the entity."
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
description string (14) "User profiles."
class => string (54) "Drupal\profile\Plugin\Field\ProfileEntityFieldItemList"
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (16) "entity_reference"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataReferenceTargetDefinition.php:22
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:69
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:100
public getEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:119
public setEntityTypeId($entity_type_id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:126
public getBundles() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:133
public setBundles(?array $bundles = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:141
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ComplexDataDefinitionBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php:25
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ComplexDataDefinitionBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php:35
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ComplexDataDefinitionBase
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComplexDataDefinitionBase.php:42
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Entity\TypedData\EntityDataDefinition::create($entity_type_id = null, $bundle = null): static Creates a new entity definition.
/**
* Creates a new entity definition.
*
* @param string $entity_type_id
* (optional) The ID of the entity type, or NULL if the entity type is
* unknown. Defaults to NULL.
* @param string $bundle
* (optional) The bundle of the entity type, or NULL if the bundle is
* unknown. Defaults to NULL.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:24
public static Drupal\Core\Entity\TypedData\EntityDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/TypedData/EntityDataDefinition.php:58
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public getTargetDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataReferenceDefinition.php:48
public setTargetDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the definition of the referenced data.
/**
* Sets the definition of the referenced data.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* The target definition to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataReferenceDefinition.php:60
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\TypedData\DataReferenceDefinition::create($target_data_type): static Creates a new data reference definition.
/**
* Creates a new data reference definition.
*
* @param string $target_data_type
* The data type of the referenced data.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataReferenceDefinition.php:28
public static Drupal\Core\TypedData\DataReferenceDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataReferenceDefinition.php:37
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
public getFieldDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
public setFieldDefinition($field_definition) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
public getLabel(): string Gets the label of the field type.
/**
* Gets the label of the field type.
*
* If the label hasn't been set, then fall back to the label of the
* typed data definition.
*
* @return string
* The label of the field type.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101
public __construct(array $values = array()) Constructs a new data definition object.
/**
* Constructs a new data definition object.
*
* @param array $values
* (optional) If given, an array of initial values to set on the definition.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
public setDataType($type): static Sets the data type.
/**
* Sets the data type.
*
* @param string $type
* The data type to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
public setSettings(array $settings): static Sets the array of settings, as required by the used class.
/**
* Sets the array of settings, as required by the used class.
*
* @param array $settings
* The array of settings.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
public setSetting($setting_name, $value): static Sets a definition setting.
/**
* Sets a definition setting.
*
* @param string $setting_name
* The definition setting to set.
* @param mixed $value
* The value to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.
/**
* Creates a new field item definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition the item definition belongs to.
*
* @return static
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
protected type -> string (4) "path"
protected propertyDefinitions -> null
protected schema -> null
protected indexes -> array (0)
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
public setName($name): static Sets the field name.
/**
* Sets the field name.
*
* @param string $name
* The field name to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*
* Note that the method does not unset existing settings not specified in the
* incoming $settings array.
*
* For example:
* @code
* // Given these are the default settings.
* $field_definition->getSettings() === [
* 'fruit' => 'apple',
* 'season' => 'summer',
* ];
* // Change only the 'fruit' setting.
* $field_definition->setSettings(['fruit' => 'banana']);
* // The 'season' setting persists unchanged.
* $field_definition->getSettings() === [
* 'fruit' => 'banana',
* 'season' => 'summer',
* ];
* @endcode
*
* For clarity, it is preferred to use setSetting() if not all available
* settings are supplied.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
public setProvider($provider): $this Sets the name of the provider of this field.
/**
* Sets the name of the provider of this field.
*
* @param string $provider
* The provider name to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
public setTranslatable($translatable): $this Sets whether the field is translatable.
/**
* Sets whether the field is translatable.
*
* @param bool $translatable
* Whether the field is translatable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
public setRevisionable($revisionable): $this Sets whether the field is revisionable.
/**
* Sets whether the field is revisionable.
*
* @param bool $revisionable
* Whether the field is revisionable.
*
* @return $this
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
public getCardinality() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.
/**
* Sets the maximum number of items allowed for the field.
*
* Possible values are positive integers or
* FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
*
* Note that if the entity type that this base field is attached to is
* revisionable and the field has a cardinality higher than 1, the field is
* considered revisionable by default.
*
* @param int $cardinality
* The field cardinality.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
public isMultiple() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.
/**
* Sets constraints for a given field item property.
*
* Note: this overwrites any existing property constraints. If you need to
* add to the existing constraints, use
* \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306
public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.
/**
* Adds constraints for a given field item property.
*
* Adds a constraint to a property of a base field item. e.g.
* @code
* // Limit the field item's value property to the range 0 through 10.
* // e.g. $node->size->value.
* $field->addPropertyConstraints('value', [
* 'Range' => [
* 'min' => 0,
* 'max' => 10,
* ]
* ]);
* @endcode
*
* If you want to add a validation constraint that applies to the
* \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
* instead.
*
* Note: passing a new set of options for an existing property constraint will
* overwrite with the new options.
*
* @param string $name
* The name of the property to set constraints for.
* @param array $constraints
* The constraints to set.
*
* @return static
* The object itself for chaining.
*
* @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345
public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.
/**
* Sets the display options for the field in forms or rendered entities.
*
* This enables generic rendering of the field with widgets / formatters,
* including automated support for "In place editing", and with optional
* configurability in the "Manage display" / "Manage form display" UI screens.
*
* Unless this method is called, the field remains invisible (or requires
* ad-hoc rendering logic).
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param array $options
* An array of display options. Refer to
* \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
* a list of supported keys. The options should include at least a 'weight',
* or specify 'region' = 'hidden'. The 'default_widget' /
* 'default_formatter' for the field type will be used if no 'type' is
* specified.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381
public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.
/**
* Sets whether the display for the field can be configured.
*
* @param string $display_context
* The display context. Either 'view' or 'form'.
* @param bool $configurable
* Whether the display options can be configured (e.g., via the "Manage
* display" / "Manage form display" UI screens). If TRUE, the options
* specified via getDisplayOptions() act as defaults.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411
public isDisplayConfigurable($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476
public getInitialValue(): array Returns the initial value for the field.
/**
* Returns the initial value for the field.
*
* @return array
* The initial value for the field, as a numerically indexed array of items,
* each item being a property/value array. An empty array when there is no
* default value.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492
public setInitialValue($value): $this Sets an initial value for the field.
/**
* Sets an initial value for the field.
*
* @param mixed $value
* The initial value for the field. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511
public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.
/**
* Returns the name of the field that will be used for getting initial values.
*
* @return string|null
* The field name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528
public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.
/**
* Sets a field that will be used for getting initial values.
*
* @param string $field_name
* The name of the field that will be used for getting initial values.
* @param mixed $default_value
* (optional) The default value for the field, in case the inherited value
* is NULL. This can be either:
* - a literal, in which case it will be assigned to the first property of
* the first item;
* - a numerically indexed array of items, each item being a property/value
* array;
* - a non-numerically indexed array, in which case the array is assumed to
* be a property/value array and used as the first item;
* - an empty array for no initial value.
* If the field being added is required or an entity key, it is recommended
* to provide a default value.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552
public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561
public getPropertyDefinition($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576
public getPropertyDefinitions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591
public getPropertyNames() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
public getMainPropertyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627
public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.
/**
* Sets the ID of the type of the entity this field is attached to.
*
* @param string $entity_type_id
* The name of the target entity type to set.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647
public setTargetBundle($bundle): $this Sets the bundle this field is defined for.
/**
* Sets the bundle this field is defined for.
*
* @param string|null $bundle
* The bundle, or NULL if the field is not bundle-specific.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659
public getSchema() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667
public getColumns() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694
public hasCustomStorage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702
public isBaseField() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709
public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.
/**
* Sets the storage behavior for this field.
*
* @param bool $custom_storage
* Pass FALSE if the storage takes care of storing the field,
* TRUE otherwise.
*
* @return $this
*
* @throws \LogicException
* Thrown if custom storage is to be set to FALSE for a computed field.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736
public getUniqueStorageIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763
public setDeleted($deleted): $this Sets whether the field storage is deleted.
/**
* Sets whether the field storage is deleted.
*
* @param bool $deleted
* Whether the field storage is deleted.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783
public isStorageRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794
public setStorageRequired($required): static Sets whether the field storage is required.
/**
* Sets whether the field storage is required.
*
* @param bool $required
* Whether the field storage is required.
*
* @return static
* The object itself for chaining.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812
public __clone() Magic method: Implements a deep clone.
/**
* Magic method: Implements a deep clone.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837
public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
public setDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.
/**
* Sets the item definition.
*
* @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
* A list item's data definition.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
public setLabel($label): static Sets the human-readable label.
/**
* Sets the human-readable label.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
* The label to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
public setDescription($description): static Sets the human-readable description.
/**
* Sets the human-readable description.
*
* @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
* The description to set.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
public setReadOnly($read_only): static Sets whether the data is read-only.
/**
* Sets whether the data is read-only.
*
* @param bool $read_only
* Whether the data is read-only.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
public setComputed($computed): static Sets whether the data is computed.
/**
* Sets whether the data is computed.
*
* @param bool $computed
* Whether the data is computed.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
public setRequired($required): static Sets whether the data is required.
/**
* Sets whether the data is required.
*
* @param bool $required
* Whether the data is required.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
public setClass($class): static Sets the class used for creating the typed data object.
/**
* Sets the class used for creating the typed data object.
*
* @param string|null $class
* The class to use.
*
* @return static
* The object itself for chaining.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283
public setConstraints(array $constraints): $this Sets an array of validation constraints.
/**
* Sets an array of validation constraints.
*
* @param array $constraints
* An array of validation constraint definitions, keyed by constraint name.
* Each constraint definition can be used for instantiating
* \Symfony\Component\Validator\Constraint objects.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306
public offsetExists($offset): bool {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318
public & offsetGet($offset): mixed {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331
public offsetSet($offset, $value): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345
public offsetUnset($offset): void {@inheritdoc}
/**
* {@inheritdoc}
*
* This is for BC support only.
*
* @todo Remove in https://www.drupal.org/node/1928868.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356
public toArray(): array Returns all definition values as array.
/**
* Returns all definition values as array.
*
* @return array
* The array holding values for all definition keys.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366
public setInternal($internal): $this Sets the whether the data value should be internal.
/**
* Sets the whether the data value should be internal.
*
* @param bool $internal
* Whether the data value should be internal.
*
* @return $this
*
* @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401
public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.
/**
* Sets the typed data manager.
*
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
* The typed data manager.
*
* @return $this
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.
/**
* Gets the typed data manager.
*
* @return \Drupal\Core\TypedData\TypedDataManagerInterface
* The typed data manager.
*/
Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.
/**
* Creates a new field definition.
*
* @param string $type
* The type of the field.
*
* @return static
* A new field definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.
/**
* Creates a new field definition based upon a field storage definition.
*
* In cases where one needs a field storage definitions to act like full
* field definitions, this creates a new field definition based upon the
* (limited) information available. That way it is possible to use the field
* definition in places where a full field definition is required; e.g., with
* widgets or formatters.
*
* @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
* The field storage definition to base the new field definition upon.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.
/**
* Creates a new list definition.
*
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new List Data Definition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26
public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43
public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.
/**
* Creates a new data definition.
*
* @param string $type
* The data type of the data; e.g., 'string', 'integer' or 'any'.
*
* @return static
* A new DataDefinition object.
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28
public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36
public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
public __construct(array $values, $entity_type = 'field_config') Constructs a FieldConfig object.
/**
* Constructs a FieldConfig object.
*
* In most cases, Field entities are created via
* FieldConfig::create($values), where $values is the same
* parameter as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. The
* storage associated with the field can be specified either with:
* - field_storage: the FieldStorageConfigInterface object,
* or by referring to an existing field storage in the current configuration
* with:
* - field_name: The field name.
* - entity_type: The entity type.
* Additionally, a 'bundle' property is required to indicate the entity
* bundle to which the field is attached to. Other array elements will be
* used to set the corresponding properties on the class; see the class
* property documentation for details.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:110
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:143
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\EntityBase::preSave().
/**
* Overrides \Drupal\Core\Entity\EntityBase::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:165
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:201
protected linkTemplates() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:264
protected urlRouteParameters($rel) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:280
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:291
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:298
public isDisplayConfigurable($context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:332
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:339
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:347
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:354
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:361
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:200
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:207
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:214
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:221
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:228
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:262
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:310
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:324
public setLabel($label) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:332
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:340
public setDescription($description) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:348
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:356
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:365
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:373
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:381
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:389
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:401
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:409
public setRequired($required) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:417
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:425
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:442
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:450
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:458
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465
public __sleep(): array Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
*
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578
public setConstraints(array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593
public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601
public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629
public getOriginalId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127
public setOriginalId($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:134
public isNew() Overrides EntityBase::isNew().
/**
* Overrides EntityBase::isNew().
*
* EntityInterface::enforceIsNew() is only supported for newly created
* configuration entities but has no effect after saving, since each
* configuration entity is unique.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158
public set($property_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:166
public enable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:184
public disable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:192
public setStatus($status) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:200
public status() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:208
public setUninstalling($uninstalling) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:215
public isUninstalling() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:222
public createDuplicate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:254
protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/**
* Gets the typed config manager.
*
* @return \Drupal\Core\Config\TypedConfigManagerInterface
* The typed configuration plugin manager.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:290
public toUrl($rel = null, array $options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:408
public getCacheTagsToInvalidate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:417
/**
* Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
*
* Note that this function should only be called from implementations of
* \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
* as dependencies are recalculated during every entity save.
*
* @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:432
public getDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:446
public getConfigDependencyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:460
public getConfigTarget() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:467
/**
* {@inheritdoc}
*
* Override to never invalidate the entity's cache tag; the config system
* already invalidates it.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509
public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:531
public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:539
public getThirdPartySettings($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:551
public unsetThirdPartySetting($module, $key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:558
public getThirdPartyProviders() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:571
public isInstallable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612
public trustData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:619
public hasTrustedData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:627
public save() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:634
protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/**
* Gets the entity type manager.
*
* @return \Drupal\Core\Entity\EntityTypeManagerInterface
* The entity type manager.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85
protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/**
* Gets the entity type bundle info service.
*
* @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
* The entity type bundle info service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95
protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/**
* Gets the language manager.
*
* @return \Drupal\Core\Language\LanguageManagerInterface
* The language manager service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105
protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/**
* Gets the UUID generator.
*
* @return \Drupal\Component\Uuid\UuidInterface
* The UUID service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115
public uuid() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:129
public enforceIsNew($value = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
public getEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152
public bundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159
public label() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:166
public hasLinkTemplate($rel) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271
public uriRelationships() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315
public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:337
public language() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:351
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376
public getEntityType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408
public referencedEntities() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:466
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473
protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/**
* The list cache tags to invalidate for this entity.
*
* @return string[]
* Set of list cache tags.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517
public getTypedData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628
public getConfigDependencyKey() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673
public getOriginal(): ?static {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696
public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:711
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:722
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:734
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:745
public addCacheableDependency($other_object) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
public addCacheContexts(array $cache_contexts) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32
public addCacheTags(array $cache_tags) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42
public mergeCacheMaxAge($max_age) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52
protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/**
* Sets cacheability; useful for value object constructors.
*
* @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
* The cacheability to set.
*
* @return $this
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
public traitSleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/**
* Calculates and returns dependencies of a specific plugin instance.
*
* Dependencies are added for the module that provides the plugin, as well
* as any dependencies declared by the instance's calculateDependencies()
* method, if it implements
* \Drupal\Component\Plugin\DependentPluginInterface.
*
* @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
* The plugin instance.
*
* @return array
* An array of dependencies keyed by the type of dependency.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/**
* Calculates and adds dependencies of a specific plugin instance.
*
* Dependencies are added for the module that provides the plugin, as well
* as any dependencies declared by the instance's calculateDependencies()
* method, if it implements
* \Drupal\Component\Plugin\DependentPluginInterface.
*
* @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
* The plugin instance.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/**
* Wraps the module handler.
*
* @return \Drupal\Core\Extension\ModuleHandlerInterface
* The module handler.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/**
* Wraps the theme handler.
*
* @return \Drupal\Core\Extension\ThemeHandlerInterface
* The theme handler.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
protected addDependencyTrait($type, $name): $this Adds a dependency.
/**
* Adds a dependency.
*
* @param string $type
* Type of dependency being added: 'module', 'theme', 'config', 'content'.
* @param string $name
* If $type is 'module' or 'theme', the name of the module or theme. If
* $type is 'config' or 'content', the result of
* EntityInterface::getConfigDependencyName().
*
* @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
*
* @return $this
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
/**
* Adds multiple dependencies.
*
* @param array $dependencies
* An array of dependencies keyed by the type of dependency. One example:
* @code
* [
* 'module' => [
* 'node',
* 'field',
* 'image',
* ],
* ];
* @endcode
*
* @see \Drupal\Core\Entity\DependencyTrait::addDependency
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
public setSyncing($syncing) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
public isSyncing() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/**
* Returns the typed data class name for this entity.
*
* @return string
* The string representing the typed data class name.
*
* @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644
public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:211
public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:237
public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and field name.
/**
* Loads a field config entity based on the entity type and field name.
*
* @param string $entity_type_id
* ID of the entity type.
* @param string $bundle
* Bundle name.
* @param string $field_name
* Name of the field.
*
* @return \Drupal\field\FieldConfigInterface|null
* The field config entity if one exists for the provided field
* name, otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:379
public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491
public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500
public static Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Callback for uasort() to sort configuration entities by weight and label.
/**
* Callback for uasort() to sort configuration entities by weight and label.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:240
/**
* {@inheritdoc}
*
* Override to never invalidate the individual entities' cache tags; the
* config system already invalidates them.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:519
protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/**
* Gets the configuration manager.
*
* @return \Drupal\Core\Config\ConfigManager
* The configuration manager.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605
public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:435
public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:460
public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:524
public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:534
public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:544
protected static Drupal\Core\Field\FieldConfigBase::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:295
public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:578
public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:453
public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:447
protected static Drupal\Core\Entity\EntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.
/**
* Invalidates an entity's cache tags upon delete.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityInterface[] $entities
* An array of entities.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582
protected description -> string (76) "Please provide the name of the person who has referred you to CounsellingBC."
protected settings -> array (2)
handler => string (12) "default:user"
handler_settings => array (5)
target_bundles => null
sort => array (2)
field => string (4) "name"
direction => string (3) "ASC"
auto_create => boolean false
filter => array (1)
type => string (5) "_none"
include_anonymous => boolean false
protected required -> boolean false
protected translatable -> boolean false
protected default_value -> array (0)
protected default_value_callback -> string (0) ""
protected fieldStorage -> null
protected itemDefinition -> null
protected constraints -> array (0)
protected propertyConstraints -> array (0)
protected deleted -> boolean false
public __construct(array $values, $entity_type = 'field_config') Constructs a FieldConfig object.
/**
* Constructs a FieldConfig object.
*
* In most cases, Field entities are created via
* FieldConfig::create($values), where $values is the same
* parameter as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. The
* storage associated with the field can be specified either with:
* - field_storage: the FieldStorageConfigInterface object,
* or by referring to an existing field storage in the current configuration
* with:
* - field_name: The field name.
* - entity_type: The entity type.
* Additionally, a 'bundle' property is required to indicate the entity
* bundle to which the field is attached to. Other array elements will be
* used to set the corresponding properties on the class; see the class
* property documentation for details.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:110
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:143
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\EntityBase::preSave().
/**
* Overrides \Drupal\Core\Entity\EntityBase::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:165
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:201
protected linkTemplates() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:264
protected urlRouteParameters($rel) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:280
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:291
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:298
public isDisplayConfigurable($context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:332
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:339
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:347
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:354
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:361
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:200
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:207
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:214
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:221
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:228
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:262
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:310
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:324
public setLabel($label) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:332
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:340
public setDescription($description) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:348
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:356
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:365
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:373
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:381
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:389
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:401
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:409
public setRequired($required) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:417
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:425
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:442
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:450
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:458
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465
public __sleep(): array Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
*
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578
public setConstraints(array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593
public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601
public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629
public getOriginalId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127
public setOriginalId($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:134
public isNew() Overrides EntityBase::isNew().
/**
* Overrides EntityBase::isNew().
*
* EntityInterface::enforceIsNew() is only supported for newly created
* configuration entities but has no effect after saving, since each
* configuration entity is unique.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158
public set($property_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:166
public enable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:184
public disable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:192
public setStatus($status) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:200
public status() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:208
public setUninstalling($uninstalling) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:215
public isUninstalling() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:222
public createDuplicate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:254
protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/**
* Gets the typed config manager.
*
* @return \Drupal\Core\Config\TypedConfigManagerInterface
* The typed configuration plugin manager.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:290
public toUrl($rel = null, array $options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:408
public getCacheTagsToInvalidate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:417
/**
* Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
*
* Note that this function should only be called from implementations of
* \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
* as dependencies are recalculated during every entity save.
*
* @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:432
public getDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:446
public getConfigDependencyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:460
public getConfigTarget() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:467
/**
* {@inheritdoc}
*
* Override to never invalidate the entity's cache tag; the config system
* already invalidates it.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509
public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:531
public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:539
public getThirdPartySettings($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:551
public unsetThirdPartySetting($module, $key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:558
public getThirdPartyProviders() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:571
public isInstallable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612
public trustData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:619
public hasTrustedData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:627
public save() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:634
protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/**
* Gets the entity type manager.
*
* @return \Drupal\Core\Entity\EntityTypeManagerInterface
* The entity type manager.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85
protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/**
* Gets the entity type bundle info service.
*
* @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
* The entity type bundle info service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95
protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/**
* Gets the language manager.
*
* @return \Drupal\Core\Language\LanguageManagerInterface
* The language manager service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105
protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/**
* Gets the UUID generator.
*
* @return \Drupal\Component\Uuid\UuidInterface
* The UUID service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115
public uuid() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:129
public enforceIsNew($value = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
public getEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152
public bundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159
public label() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:166
public hasLinkTemplate($rel) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271
public uriRelationships() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315
public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:337
public language() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:351
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376
public getEntityType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408
public referencedEntities() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:466
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473
protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/**
* The list cache tags to invalidate for this entity.
*
* @return string[]
* Set of list cache tags.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517
public getTypedData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628
public getConfigDependencyKey() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673
public getOriginal(): ?static {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696
public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:711
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:722
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:734
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:745
public addCacheableDependency($other_object) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
public addCacheContexts(array $cache_contexts) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32
public addCacheTags(array $cache_tags) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42
public mergeCacheMaxAge($max_age) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52
protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/**
* Sets cacheability; useful for value object constructors.
*
* @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
* The cacheability to set.
*
* @return $this
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
public traitSleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/**
* Calculates and returns dependencies of a specific plugin instance.
*
* Dependencies are added for the module that provides the plugin, as well
* as any dependencies declared by the instance's calculateDependencies()
* method, if it implements
* \Drupal\Component\Plugin\DependentPluginInterface.
*
* @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
* The plugin instance.
*
* @return array
* An array of dependencies keyed by the type of dependency.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/**
* Calculates and adds dependencies of a specific plugin instance.
*
* Dependencies are added for the module that provides the plugin, as well
* as any dependencies declared by the instance's calculateDependencies()
* method, if it implements
* \Drupal\Component\Plugin\DependentPluginInterface.
*
* @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
* The plugin instance.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/**
* Wraps the module handler.
*
* @return \Drupal\Core\Extension\ModuleHandlerInterface
* The module handler.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/**
* Wraps the theme handler.
*
* @return \Drupal\Core\Extension\ThemeHandlerInterface
* The theme handler.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
protected addDependencyTrait($type, $name): $this Adds a dependency.
/**
* Adds a dependency.
*
* @param string $type
* Type of dependency being added: 'module', 'theme', 'config', 'content'.
* @param string $name
* If $type is 'module' or 'theme', the name of the module or theme. If
* $type is 'config' or 'content', the result of
* EntityInterface::getConfigDependencyName().
*
* @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
*
* @return $this
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
/**
* Adds multiple dependencies.
*
* @param array $dependencies
* An array of dependencies keyed by the type of dependency. One example:
* @code
* [
* 'module' => [
* 'node',
* 'field',
* 'image',
* ],
* ];
* @endcode
*
* @see \Drupal\Core\Entity\DependencyTrait::addDependency
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
public setSyncing($syncing) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
public isSyncing() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/**
* Returns the typed data class name for this entity.
*
* @return string
* The string representing the typed data class name.
*
* @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644
public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:211
public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:237
public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and field name.
/**
* Loads a field config entity based on the entity type and field name.
*
* @param string $entity_type_id
* ID of the entity type.
* @param string $bundle
* Bundle name.
* @param string $field_name
* Name of the field.
*
* @return \Drupal\field\FieldConfigInterface|null
* The field config entity if one exists for the provided field
* name, otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:379
public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491
public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500
public static Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Callback for uasort() to sort configuration entities by weight and label.
/**
* Callback for uasort() to sort configuration entities by weight and label.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:240
/**
* {@inheritdoc}
*
* Override to never invalidate the individual entities' cache tags; the
* config system already invalidates them.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:519
protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/**
* Gets the configuration manager.
*
* @return \Drupal\Core\Config\ConfigManager
* The configuration manager.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605
public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:435
public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:460
public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:524
public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:534
public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:544
protected static Drupal\Core\Field\FieldConfigBase::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:295
public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:578
public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:453
public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:447
protected static Drupal\Core\Entity\EntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.
/**
* Invalidates an entity's cache tags upon delete.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityInterface[] $entities
* An array of entities.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582
public __construct(array $values, $entity_type = 'field_config') Constructs a FieldConfig object.
/**
* Constructs a FieldConfig object.
*
* In most cases, Field entities are created via
* FieldConfig::create($values), where $values is the same
* parameter as in this constructor.
*
* @param array $values
* An array of field properties, keyed by property name. The
* storage associated with the field can be specified either with:
* - field_storage: the FieldStorageConfigInterface object,
* or by referring to an existing field storage in the current configuration
* with:
* - field_name: The field name.
* - entity_type: The entity type.
* Additionally, a 'bundle' property is required to indicate the entity
* bundle to which the field is attached to. Other array elements will be
* used to set the corresponding properties on the class; see the class
* property documentation for details.
* @param string $entity_type
* (optional) The entity type on which the field should be created.
* Defaults to "field_config".
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:110
public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:143
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\EntityBase::preSave().
/**
* Overrides \Drupal\Core\Entity\EntityBase::preSave().
*
* @throws \Drupal\Core\Field\FieldException
* If the field definition is invalid.
* @throws \Drupal\Core\Entity\EntityStorageException
* In case of failures at the configuration storage level.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:165
public calculateDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:201
protected linkTemplates() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:264
protected urlRouteParameters($rel) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:280
public isDeleted() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:291
public getFieldStorageDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:298
public isDisplayConfigurable($context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:332
public getDisplayOptions($display_context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:339
public isReadOnly() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:347
public isComputed() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:354
public getUniqueIdentifier() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:361
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:200
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:207
public getType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:214
public getTargetEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:221
public getTargetBundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:228
public onDependencyRemoval(array $dependencies) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:262
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:310
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:324
public setLabel($label) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:332
public getDescription() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:340
public setDescription($description) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:348
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:356
public setTranslatable($translatable) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:365
public getSettings() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:373
public setSettings(array $settings) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:381
public getSetting($setting_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:389
public setSetting($setting_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:401
public isRequired() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:409
public setRequired($required) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:417
public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:425
public getDefaultValueLiteral() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:442
public setDefaultValue($value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:450
public getDefaultValueCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:458
public setDefaultValueCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465
public __sleep(): array Implements the magic __sleep() method.
/**
* Implements the magic __sleep() method.
*
* Using the Serialize interface and serialize() / unserialize() methods
* breaks entity forms in PHP 5.4.
*
* @todo Investigate in https://www.drupal.org/node/1977206.
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478
public getDataType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509
public isList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539
public getConstraint($constraint_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546
public getItemDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554
public getConfig($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578
public setConstraints(array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593
public setPropertyConstraints($name, array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601
public addPropertyConstraints($name, array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629
public getOriginalId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127
public setOriginalId($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:134
public isNew() Overrides EntityBase::isNew().
/**
* Overrides EntityBase::isNew().
*
* EntityInterface::enforceIsNew() is only supported for newly created
* configuration entities but has no effect after saving, since each
* configuration entity is unique.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151
public get($property_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158
public set($property_name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:166
public enable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:184
public disable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:192
public setStatus($status) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:200
public status() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:208
public setUninstalling($uninstalling) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:215
public isUninstalling() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:222
public createDuplicate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229
public toArray() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:254
protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.
/**
* Gets the typed config manager.
*
* @return \Drupal\Core\Config\TypedConfigManagerInterface
* The typed configuration plugin manager.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:290
public toUrl($rel = null, array $options = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:408
public getCacheTagsToInvalidate() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:417
/**
* Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
*
* Note that this function should only be called from implementations of
* \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
* as dependencies are recalculated during every entity save.
*
* @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:432
public getDependencies() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:446
public getConfigDependencyName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:460
public getConfigTarget() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:467
/**
* {@inheritdoc}
*
* Override to never invalidate the entity's cache tag; the config system
* already invalidates it.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509
public setThirdPartySetting($module, $key, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:531
public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:539
public getThirdPartySettings($module) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:551
public unsetThirdPartySetting($module, $key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:558
public getThirdPartyProviders() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:571
public isInstallable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612
public trustData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:619
public hasTrustedData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:627
public save() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:634
protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/**
* Gets the entity type manager.
*
* @return \Drupal\Core\Entity\EntityTypeManagerInterface
* The entity type manager.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85
protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/**
* Gets the entity type bundle info service.
*
* @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
* The entity type bundle info service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95
protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/**
* Gets the language manager.
*
* @return \Drupal\Core\Language\LanguageManagerInterface
* The language manager service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105
protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/**
* Gets the UUID generator.
*
* @return \Drupal\Component\Uuid\UuidInterface
* The UUID service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115
public uuid() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:129
public enforceIsNew($value = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
public getEntityTypeId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152
public bundle() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159
public label() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:166
public hasLinkTemplate($rel) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271
public uriRelationships() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315
public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:337
public language() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:351
public delete() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376
public getEntityType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408
public referencedEntities() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:466
public getCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473
protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/**
* The list cache tags to invalidate for this entity.
*
* @return string[]
* Set of list cache tags.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483
public getCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507
public getCacheMaxAge() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517
public getTypedData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628
public getConfigDependencyKey() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673
public getOriginal(): ?static {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696
public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703
public __get($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:711
public __set($name, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:722
public __isset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:734
public __unset($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:745
public addCacheableDependency($other_object) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
public addCacheContexts(array $cache_contexts) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32
public addCacheTags(array $cache_tags) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42
public mergeCacheMaxAge($max_age) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52
protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/**
* Sets cacheability; useful for value object constructors.
*
* @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
* The cacheability to set.
*
* @return $this
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
public traitSleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.
/**
* Calculates and returns dependencies of a specific plugin instance.
*
* Dependencies are added for the module that provides the plugin, as well
* as any dependencies declared by the instance's calculateDependencies()
* method, if it implements
* \Drupal\Component\Plugin\DependentPluginInterface.
*
* @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
* The plugin instance.
*
* @return array
* An array of dependencies keyed by the type of dependency.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.
/**
* Calculates and adds dependencies of a specific plugin instance.
*
* Dependencies are added for the module that provides the plugin, as well
* as any dependencies declared by the instance's calculateDependencies()
* method, if it implements
* \Drupal\Component\Plugin\DependentPluginInterface.
*
* @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
* The plugin instance.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88
protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.
/**
* Wraps the module handler.
*
* @return \Drupal\Core\Extension\ModuleHandlerInterface
* The module handler.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98
protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.
/**
* Wraps the theme handler.
*
* @return \Drupal\Core\Extension\ThemeHandlerInterface
* The theme handler.
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108
protected addDependencyTrait($type, $name): $this Adds a dependency.
/**
* Adds a dependency.
*
* @param string $type
* Type of dependency being added: 'module', 'theme', 'config', 'content'.
* @param string $name
* If $type is 'module' or 'theme', the name of the module or theme. If
* $type is 'config' or 'content', the result of
* EntityInterface::getConfigDependencyName().
*
* @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
*
* @return $this
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
/**
* Adds multiple dependencies.
*
* @param array $dependencies
* An array of dependencies keyed by the type of dependency. One example:
* @code
* [
* 'module' => [
* 'node',
* 'field',
* 'image',
* ],
* ];
* @endcode
*
* @see \Drupal\Core\Entity\DependencyTrait::addDependency
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
public setSyncing($syncing) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
public isSyncing() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/**
* Returns the typed data class name for this entity.
*
* @return string
* The string representing the typed data class name.
*
* @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644
public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:211
public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:237
public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and field name.
/**
* Loads a field config entity based on the entity type and field name.
*
* @param string $entity_type_id
* ID of the entity type.
* @param string $bundle
* Bundle name.
* @param string $field_name
* Name of the field.
*
* @return \Drupal\field\FieldConfigInterface|null
* The field config entity if one exists for the provided field
* name, otherwise NULL.
*/
Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:379
public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491
public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500
public static Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Callback for uasort() to sort configuration entities by weight and label.
/**
* Callback for uasort() to sort configuration entities by weight and label.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:240
/**
* {@inheritdoc}
*
* Override to never invalidate the individual entities' cache tags; the
* config system already invalidates them.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:519
protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.
/**
* Gets the configuration manager.
*
* @return \Drupal\Core\Config\ConfigManager
* The configuration manager.
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605
public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:435
public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:460
public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:524
public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:534
public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:544
protected static Drupal\Core\Field\FieldConfigBase::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.
/**
* Ensure a field value is transformed into a format keyed by delta.
*
* @param mixed $value
* The raw field value to normalize.
* @param string|null $main_property_name
* The main field property name.
*
* @return array
* A field value normalized into a format keyed by delta.
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:295
public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:578
public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:453
public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:447
protected static Drupal\Core\Entity\EntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.
/**
* Invalidates an entity's cache tags upon delete.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityInterface[] $entities
* An array of entities.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582
protected languages -> array (3)
en => Drupal\Core\Language\Language#209 (5)
Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)
protected name -> string (7) "English"
protected id -> string (2) "en"
protected direction -> string (3) "ltr"
protected weight -> integer 0
protected locked -> boolean false
public __construct(array $values = array()) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* @param array $values
* An array of property values, keyed by property name, used to construct
* the language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:77
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101
public getId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108
public getDirection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115
public getWeight() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122
public isDefault() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136
public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.
/**
* Sort language objects.
*
* @param \Drupal\Core\Language\LanguageInterface[] $languages
* The array of language objects keyed by langcode.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146
protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.
/**
* Gets the default langcode.
*
* @return string
* The current default langcode.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173
public static Drupal\Core\Language\Language::$defaultValues :: array (5)
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SYSTEM :: string (6) "system"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED :: string (3) "und"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_APPLICABLE :: string (3) "zxx"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT :: string (9) "x-default"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SITE_DEFAULT :: string (12) "site_default"
public const Drupal\Core\Language\LanguageInterface::VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
public const Drupal\Core\Language\LanguageInterface::STATE_CONFIGURABLE :: integer 1
public const Drupal\Core\Language\LanguageInterface::STATE_LOCKED :: integer 2
public const Drupal\Core\Language\LanguageInterface::STATE_ALL :: integer 3
public const Drupal\Core\Language\LanguageInterface::STATE_SITE_DEFAULT :: integer 4
public const Drupal\Core\Language\LanguageInterface::TYPE_CONTENT :: string (16) "language_content"
public const Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE :: string (18) "language_interface"
public const Drupal\Core\Language\LanguageInterface::TYPE_URL :: string (12) "language_url"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_LTR :: string (3) "ltr"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_RTL :: string (3) "rtl"
und => Drupal\Core\Language\Language#2230 (5)
Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)
protected name -> Drupal\Core\StringTranslation\TranslatableMarkup#2231 (5)
Properties (5)
Methods (12)
Static methods (2)
toString
protected string -> string (13) "Not specified"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
name string (13) "Not specified"
protected id -> string (3) "und"
protected direction -> string (3) "ltr"
protected weight -> integer 1
protected locked -> boolean true
public __construct(array $values = array()) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* @param array $values
* An array of property values, keyed by property name, used to construct
* the language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:77
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101
public getId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108
public getDirection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115
public getWeight() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122
public isDefault() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136
public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.
/**
* Sort language objects.
*
* @param \Drupal\Core\Language\LanguageInterface[] $languages
* The array of language objects keyed by langcode.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146
protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.
/**
* Gets the default langcode.
*
* @return string
* The current default langcode.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173
public static Drupal\Core\Language\Language::$defaultValues :: array (5)
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SYSTEM :: string (6) "system"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED :: string (3) "und"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_APPLICABLE :: string (3) "zxx"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT :: string (9) "x-default"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SITE_DEFAULT :: string (12) "site_default"
public const Drupal\Core\Language\LanguageInterface::VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
public const Drupal\Core\Language\LanguageInterface::STATE_CONFIGURABLE :: integer 1
public const Drupal\Core\Language\LanguageInterface::STATE_LOCKED :: integer 2
public const Drupal\Core\Language\LanguageInterface::STATE_ALL :: integer 3
public const Drupal\Core\Language\LanguageInterface::STATE_SITE_DEFAULT :: integer 4
public const Drupal\Core\Language\LanguageInterface::TYPE_CONTENT :: string (16) "language_content"
public const Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE :: string (18) "language_interface"
public const Drupal\Core\Language\LanguageInterface::TYPE_URL :: string (12) "language_url"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_LTR :: string (3) "ltr"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_RTL :: string (3) "rtl"
zxx => Drupal\Core\Language\Language#2232 (5)
Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)
protected name -> Drupal\Core\StringTranslation\TranslatableMarkup#2233 (5)
Properties (5)
Methods (12)
Static methods (2)
toString
protected string -> string (14) "Not applicable"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
name string (14) "Not applicable"
protected id -> string (3) "zxx"
protected direction -> string (3) "ltr"
protected weight -> integer 2
protected locked -> boolean true
public __construct(array $values = array()) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* @param array $values
* An array of property values, keyed by property name, used to construct
* the language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:77
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101
public getId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108
public getDirection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115
public getWeight() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122
public isDefault() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136
public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.
/**
* Sort language objects.
*
* @param \Drupal\Core\Language\LanguageInterface[] $languages
* The array of language objects keyed by langcode.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146
protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.
/**
* Gets the default langcode.
*
* @return string
* The current default langcode.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173
public static Drupal\Core\Language\Language::$defaultValues :: array (5)
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:92
public label() {@inheritdoc}
$0['#user']->label()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:99
public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
$0['#user']->preSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:106
public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
$0['#user']->postSave()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:135
public getRoles($exclude_locked_roles = false) {@inheritdoc}
$0['#user']->getRoles()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:188
public hasRole($rid) {@inheritdoc}
$0['#user']->hasRole()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:213
public addRole($rid) {@inheritdoc}
$0['#user']->addRole()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:220
public removeRole($rid) {@inheritdoc}
$0['#user']->removeRole()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:236
public hasPermission(string $permission) {@inheritdoc}
$0['#user']->hasPermission()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:245
public getPassword() {@inheritdoc}
$0['#user']->getPassword()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:252
public setPassword($password) {@inheritdoc}
$0['#user']->setPassword()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:259
public getEmail() {@inheritdoc}
$0['#user']->getEmail()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:267
public setEmail($mail) {@inheritdoc}
$0['#user']->setEmail()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:274
public getCreatedTime() {@inheritdoc}
$0['#user']->getCreatedTime()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:282
public getLastAccessedTime() {@inheritdoc}
$0['#user']->getLastAccessedTime()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:289
public setLastAccessTime($timestamp) {@inheritdoc}
$0['#user']->setLastAccessTime()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:296
public getLastLoginTime() {@inheritdoc}
$0['#user']->getLastLoginTime()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:304
public setLastLoginTime($timestamp) {@inheritdoc}
$0['#user']->setLastLoginTime()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:311
public isActive() {@inheritdoc}
$0['#user']->isActive()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:319
public isBlocked() {@inheritdoc}
$0['#user']->isBlocked()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:326
public activate() {@inheritdoc}
$0['#user']->activate()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:333
public block() {@inheritdoc}
$0['#user']->block()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:344
public getTimeZone() {@inheritdoc}
$0['#user']->getTimeZone()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:352
public getPreferredLangcode($fallback_to_default = true) {@inheritdoc}
$0['#user']->getPreferredLangcode()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:359
public getPreferredAdminLangcode($fallback_to_default = true) {@inheritdoc}
$0['#user']->getPreferredAdminLangcode()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:373
public getInitialEmail() {@inheritdoc}
$0['#user']->getInitialEmail()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:387
public isAuthenticated() {@inheritdoc}
$0['#user']->isAuthenticated()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:394
public isAnonymous() {@inheritdoc}
$0['#user']->isAnonymous()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:401
public getAccountName() {@inheritdoc}
$0['#user']->getAccountName()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:408
public getDisplayName() {@inheritdoc}
$0['#user']->getDisplayName()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:415
public setUsername($username) {@inheritdoc}
$0['#user']->setUsername()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:424
public setExistingPassword($password) {@inheritdoc}
$0['#user']->setExistingPassword()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:432
public checkExistingPassword(Drupal\user\UserInterface $account_unchanged) {@inheritdoc}
$0['#user']->checkExistingPassword()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:440
protected getRoleStorage(): \Drupal\user\RoleStorageInterface Returns the role storage object.
/**
* Returns the role storage object.
*
* @return \Drupal\user\RoleStorageInterface
* The role storage object.
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:593
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:421
public setDefaultTranslationEnforced(?bool $enforce_default_translation): static Set or clear an override of the isDefaultTranslation() result.
$0['#user']->setDefaultTranslationEnforced()
/**
* Set or clear an override of the isDefaultTranslation() result.
*
* @param bool|null $enforce_default_translation
* If boolean value is passed, the value will override the result of
* isDefaultTranslation() method. If NULL is passed, the default logic will
* be used.
*
* @return $this
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:436
public isDefaultTranslation() {@inheritdoc}
$0['#user']->isDefaultTranslation()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:444
public getRevisionId() {@inheritdoc}
$0['#user']->getRevisionId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:454
public isTranslatable() {@inheritdoc}
$0['#user']->isTranslatable()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:461
public preSaveRevision(Drupal\Core\Entity\EntityStorageInterface $storage, stdClass $record) {@inheritdoc}
$0['#user']->preSaveRevision()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:487
public validate() {@inheritdoc}
$0['#user']->validate()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:518
public isValidationRequired() {@inheritdoc}
$0['#user']->isValidationRequired()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:527
public setValidationRequired($required) {@inheritdoc}
$0['#user']->setValidationRequired()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:534
protected clearTranslationCache() Clears entity translation object cache to remove stale references.
/**
* Clears entity translation object cache to remove stale references.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:542
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:551
public id() {@inheritdoc}
$0['#user']->id()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:569
public bundle() {@inheritdoc}
$0['#user']->bundle()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:576
public getBundleEntity(): ?Drupal\Core\Entity\EntityInterface {@inheritdoc}
$0['#user']->getBundleEntity()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:583
public uuid() {@inheritdoc}
$0['#user']->uuid()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:594
public hasField($field_name) {@inheritdoc}
$0['#user']->hasField()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:601
public get($field_name) {@inheritdoc}
$0['#user']->get()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:608
protected getTranslatedField($name, $langcode): \Drupal\Core\Field\FieldItemListInterface<\Drupal\Core\Field\FieldItemInterface> Gets a translated field.
/**
* Gets a translated field.
*
* @return \Drupal\Core\Field\FieldItemListInterface<\Drupal\Core\Field\FieldItemInterface>
* The translated field.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:621
public set($name, $value, $notify = true) {@inheritdoc}
$0['#user']->set()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:667
public getFields($include_computed = true) {@inheritdoc}
$0['#user']->getFields()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:678
public getTranslatableFields($include_computed = true) {@inheritdoc}
$0['#user']->getTranslatableFields()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:691
public getIterator(): ArrayIterator Retrieves the iterator for the object.
$0['#user']->getIterator()
/**
* Retrieves the iterator for the object.
*
* @return \ArrayIterator<string, \Drupal\Core\Field\FieldItemListInterface<\Drupal\Core\Field\FieldItemInterface>>
* The iterator.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:707
public getFieldDefinition($name) {@inheritdoc}
$0['#user']->getFieldDefinition()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:714
public getFieldDefinitions() {@inheritdoc}
$0['#user']->getFieldDefinitions()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:726
public toArray() {@inheritdoc}
$0['#user']->toArray()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:736
public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}
$0['#user']->access()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:747
public language() {@inheritdoc}
$0['#user']->language()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:761
protected setDefaultLangcode() Populates the local cache for the default language code.
/**
* Populates the local cache for the default language code.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:783
protected updateFieldLangcodes($langcode) Updates language for already instantiated fields.
/**
* Updates language for already instantiated fields.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:816
public onChange($name) {@inheritdoc}
$0['#user']->onChange()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:827
public getTranslation($langcode) {@inheritdoc}
$0['#user']->getTranslation()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:893
public getUntranslated() {@inheritdoc}
$0['#user']->getUntranslated()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:928
protected initializeTranslation($langcode): \Drupal\Core\Entity\EntityInterface Instantiates a translation object for an existing translation.
/**
* Instantiates a translation object for an existing translation.
*
* The translated entity will be a clone of the current entity with the
* specified $langcode. All translations share the same field data structures
* to ensure that all of them deal with fresh data.
*
* @param string $langcode
* The language code for the requested translation.
*
* @return \Drupal\Core\Entity\EntityInterface
* The translation object. The content properties of the translation object
* are stored as references to the main entity.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:946
public hasTranslation($langcode) {@inheritdoc}
$0['#user']->hasTranslation()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:980
public isNewTranslation() {@inheritdoc}
$0['#user']->isNewTranslation()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:990
public addTranslation($langcode, array $values = array()) {@inheritdoc}
$0['#user']->addTranslation()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:997
public removeTranslation($langcode) {@inheritdoc}
$0['#user']->removeTranslation()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1018
public getTranslationStatus($langcode) {@inheritdoc}
$0['#user']->getTranslationStatus()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1047
public getTranslationLanguages($include_default = true) {@inheritdoc}
$0['#user']->getTranslationLanguages()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1057
public updateOriginalValues() Updates the original values with the interim changes.
$0['#user']->updateOriginalValues()
/**
* Updates the original values with the interim changes.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1074
public & __get($name) Implements the magic method for getting object properties.
/**
* Implements the magic method for getting object properties.
*
* @todo A lot of code still uses non-fields (e.g. $entity->content in view
* builders) by reference. Clean that up.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1094
public __set($name, $value) Implements the magic method for setting object properties.
/**
* Implements the magic method for setting object properties.
*
* Uses default language always.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1126
public __isset($name) Implements the magic method for isset().
/**
* Implements the magic method for isset().
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1163
public __unset($name) Implements the magic method for unset().
/**
* Implements the magic method for unset().
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1175
public createDuplicate() {@inheritdoc}
$0['#user']->createDuplicate()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1209
public __clone() Magic method: Implements a deep clone.
clone $0['#user']
/**
* Magic method: Implements a deep clone.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1247
public referencedEntities() {@inheritdoc}
$0['#user']->referencedEntities()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1345
protected getEntityKey($key): mixed Gets the value of the given entity key, if defined.
/**
* Gets the value of the given entity key, if defined.
*
* @param string $key
* Name of the entity key, for example id, revision or bundle.
*
* @return mixed
* The value of the entity key, NULL if not defined.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1372
protected getFieldsToSkipFromTranslationChangesCheck(): array Returns an array of field names to skip in ::hasTranslationChanges.
/**
* Returns an array of field names to skip in ::hasTranslationChanges.
*
* @return array
* An array of field names.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1474
public hasTranslationChanges() {@inheritdoc}
$0['#user']->hasTranslationChanges()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1485
public isDefaultTranslationAffectedOnly() {@inheritdoc}
$0['#user']->isDefaultTranslationAffectedOnly()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1547
protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.
/**
* Gets the entity type manager.
*
* @return \Drupal\Core\Entity\EntityTypeManagerInterface
* The entity type manager.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85
protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.
/**
* Gets the entity type bundle info service.
*
* @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
* The entity type bundle info service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95
protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.
/**
* Gets the language manager.
*
* @return \Drupal\Core\Language\LanguageManagerInterface
* The language manager service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105
protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.
/**
* Gets the UUID generator.
*
* @return \Drupal\Component\Uuid\UuidInterface
* The UUID service.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115
public enforceIsNew($value = true) {@inheritdoc}
$0['#user']->enforceIsNew()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
public getEntityTypeId() {@inheritdoc}
$0['#user']->getEntityTypeId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152
public toUrl($rel = null, array $options = array()) {@inheritdoc}
$0['#user']->toUrl()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:175
public hasLinkTemplate($rel) {@inheritdoc}
$0['#user']->hasLinkTemplate()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253
protected linkTemplates(): array Gets an array link templates.
/**
* Gets an array link templates.
*
* @return array
* An array of link templates containing paths.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:264
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271
protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.
/**
* Gets an array of placeholders for this entity.
*
* Individual entity classes may override this method to add additional
* placeholders if desired. If so, they should be sure to replicate the
* property caching logic.
*
* @param string $rel
* The link relationship type, for example: canonical or edit-form.
*
* @return array
* An array of URI placeholders.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:294
public uriRelationships() {@inheritdoc}
$0['#user']->uriRelationships()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315
public save() {@inheritdoc}
$0['#user']->save()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:368
public delete() {@inheritdoc}
$0['#user']->delete()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376
public getEntityType() {@inheritdoc}
$0['#user']->getEntityType()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408
public getCacheContexts() {@inheritdoc}
$0['#user']->getCacheContexts()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473
protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.
/**
* The list cache tags to invalidate for this entity.
*
* @return string[]
* Set of list cache tags.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483
public getCacheTagsToInvalidate() {@inheritdoc}
$0['#user']->getCacheTagsToInvalidate()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:497
public getCacheTags() {@inheritdoc}
$0['#user']->getCacheTags()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507
public getCacheMaxAge() {@inheritdoc}
$0['#user']->getCacheMaxAge()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517
protected invalidateTagsOnSave($update) Invalidates an entity's cache tags upon save.
/**
* Invalidates an entity's cache tags upon save.
*
* @param bool $update
* TRUE if the entity has been updated, or FALSE if it has been inserted.
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:557
public getOriginalId() {@inheritdoc}
$0['#user']->getOriginalId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:599
public setOriginalId($id) {@inheritdoc}
$0['#user']->setOriginalId()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:607
public getTypedData() {@inheritdoc}
$0['#user']->getTypedData()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628
public getConfigDependencyKey() {@inheritdoc}
$0['#user']->getConfigDependencyKey()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673
public getConfigDependencyName() {@inheritdoc}
$0['#user']->getConfigDependencyName()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:680
public getConfigTarget() {@inheritdoc}
$0['#user']->getConfigTarget()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:687
public getOriginal(): ?static {@inheritdoc}
$0['#user']->getOriginal()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696
public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}
$0['#user']->setOriginal()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703
public addCacheableDependency($other_object) {@inheritdoc}
$0['#user']->addCacheableDependency()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
public addCacheContexts(array $cache_contexts) {@inheritdoc}
$0['#user']->addCacheContexts()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32
public addCacheTags(array $cache_tags) {@inheritdoc}
$0['#user']->addCacheTags()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42
public mergeCacheMaxAge($max_age) {@inheritdoc}
$0['#user']->mergeCacheMaxAge()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52
protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.
/**
* Sets cacheability; useful for value object constructors.
*
* @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
* The cacheability to set.
*
* @return $this
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
public traitSleep(): array {@inheritdoc}
$0['#user']->traitSleep()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected traitGetFieldsToSkipFromTranslationChangesCheck(Drupal\Core\Entity\ContentEntityInterface $entity): string[] Returns an array of field names to skip when checking for changes.
/**
* Returns an array of field names to skip when checking for changes.
*
* @param \Drupal\Core\Entity\ContentEntityInterface $entity
* A content entity object.
*
* @return string[]
* An array of field names.
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangesDetectionTrait.php:21
public setSyncing($syncing) {@inheritdoc}
$0['#user']->setSyncing()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
public isSyncing() {@inheritdoc}
$0['#user']->isSyncing()
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
public getChangedTimeAcrossTranslations(): int|null Returns the timestamp of the last entity change across all translations.
$0['#user']->getChangedTimeAcrossTranslations()
/**
* Returns the timestamp of the last entity change across all translations.
*
* @return int|null
* The timestamp of the last entity save operation across all translations.
* Some entities allow a NULL value indicating the changed time is unknown.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:17
public getChangedTime(): int|null Gets the timestamp of the last entity change for the current translation.
$0['#user']->getChangedTime()
/**
* Gets the timestamp of the last entity change for the current translation.
*
* @return int|null
* The timestamp of the last entity save operation. Some entities allow a
* NULL value indicating the changed time is unknown.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:33
public setChangedTime($timestamp): $this Sets the timestamp of the last entity change for the current translation.
$0['#user']->setChangedTime()
/**
* Sets the timestamp of the last entity change for the current translation.
*
* @param int $timestamp
* The timestamp of the last entity save operation.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:46
private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.
/**
* Returns the typed data class name for this entity.
*
* @return string
* The string representing the typed data class name.
*
* @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
*/
Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644
public static Drupal\user\Entity\User::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:178
public static Drupal\user\Entity\User::getAnonymousUser(): \Drupal\user\UserInterface Returns an anonymous user entity.
/**
* Returns an anonymous user entity.
*
* @return \Drupal\user\UserInterface
* An anonymous user entity.
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:452
public static Drupal\user\Entity\User::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:475
public static Drupal\user\Entity\User::getAllowedTimezones(): string[] Defines allowed timezones for the field's AllowedValues constraint.
/**
* Defines allowed timezones for the field's AllowedValues constraint.
*
* @return string[]
* The allowed values.
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:603
public static Drupal\user\Entity\User::getAllowedConfigurableLanguageCodes(): string[] Defines allowed configurable language codes for AllowedValues constraints.
/**
* Defines allowed configurable language codes for AllowedValues constraints.
*
* @return string[]
* The allowed values.
*/
Defined in <drupal>/core/modules/user/src/Entity/User.php:613
public static Drupal\Core\Entity\ContentEntityBase::create(array $values = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1192
public static Drupal\Core\Entity\ContentEntityBase::bundleFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1464
public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:435
public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:447
public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:460
public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:524
public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:534
protected static Drupal\Core\Entity\EntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.
/**
* Invalidates an entity's cache tags upon delete.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityInterface[] $entities
* An array of entities.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582
public static Drupal\Core\Entity\ContentEntityBase::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1406
public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:453
public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:544
public __construct(Drupal\Core\Site\Settings $settings) Constructs a CustomStrings object.
/**
* Constructs a CustomStrings object.
*
* @param \Drupal\Core\Site\Settings $settings
* The settings read only object.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/Translator/CustomStrings.php:31
protected getLanguage($langcode) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/Translator/CustomStrings.php:39
public getStringTranslation($langcode, $string, $context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\StringTranslation\Translator\StaticTranslation
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/Translator/StaticTranslation.php:33
public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\StringTranslation\Translator\StaticTranslation
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/Translator/StaticTranslation.php:48
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected defaultLangcode -> string (2) "en"
public __construct(Drupal\Core\Language\LanguageDefault $default_language) Constructs a TranslationManager object.
/**
* Constructs a TranslationManager object.
*
* @param \Drupal\Core\Language\LanguageDefault $default_language
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:52
public addTranslator(Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator, $priority = 0): $this Appends a translation system to the translation chain.
/**
* Appends a translation system to the translation chain.
*
* @param \Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator
* The translation interface to be appended to the translation chain.
* @param int $priority
* The priority of the logger being added.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:66
protected sortTranslators(): \Drupal\Core\StringTranslation\Translator\TranslatorInterface[] Sorts translators according to priority.
/**
* Sorts translators according to priority.
*
* @return \Drupal\Core\StringTranslation\Translator\TranslatorInterface[]
* A sorted array of translator objects.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
public getStringTranslation($langcode, $string, $context) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104
public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112
protected doTranslate($string, array $options = array()): string Translates a string to the current language or to a given language.
/**
* Translates a string to the current language or to a given language.
*
* @param string $string
* A string containing the English text to translate.
* @param array $options
* An associative array of additional options, with the following elements:
* - 'langcode': The language code to translate to a language other than
* what is used to display the page.
* - 'context': The context the source string belongs to.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:130
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:148
public setDefaultLangcode($langcode) Sets the default langcode.
/**
* Sets the default langcode.
*
* @param string $langcode
* A language code.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158
public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:165
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* When possible, use the
* \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
* create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
* directly.
*
* Calling the trait's t() method or instantiating a new TranslatableMarkup
* object serves two purposes:
* - At run-time it translates user-visible text into the appropriate
* language.
* - Static analyzers detect calls to t() and new TranslatableMarkup, and add
* the first argument (the string to be translated) to the database of
* strings that need translation. These strings are expected to be in
* English, so the first argument should always be in English.
* To allow the site to be localized, it is important that all human-readable
* text that will be displayed on the site or sent to a user is made available
* in one of the ways supported by the
* @link https://www.drupal.org/node/322729 Localization API @endlink.
* See the @link https://www.drupal.org/node/322729 Localization API @endlink
* pages for more information, including recommendations on how to break up or
* not break up strings for translation.
*
* @section sec_translating_vars Translating Variables
* $string should always be an English literal string.
*
* $string should never contain a variable, such as:
* @code
* new TranslatableMarkup($text)
* @endcode
* There are several reasons for this:
* - Using a variable for $string that is user input is a security risk.
* - Using a variable for $string that has even guaranteed safe text (for
* example, user interface text provided literally in code), will not be
* picked up by the localization static text processor. (The parameter could
* be a variable if the entire string in $text has been passed into t() or
* new TranslatableMarkup() elsewhere as the first argument, but that
* strategy is not recommended.)
*
* It is especially important never to call new TranslatableMarkup($user_text)
* or t($user_text) where $user_text is some text that a user entered -- doing
* that can lead to cross-site scripting and other security problems. However,
* you can use variable substitution in your string, to put variable text such
* as user names or link URLs into translated text. Variable substitution
* looks like this:
* @code
* new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
* @endcode
* Basically, you can put placeholders like @name into your string, and the
* method will substitute the sanitized values at translation time. (See the
* Localization API pages referenced above and the documentation of
* \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* for details about how to safely and correctly define variables in your
* string.) Translators can then rearrange the string as necessary for the
* language (e.g., in Spanish, it might be "blog de @name").
*
* @param string $string
* A string containing the English text to translate.
* @param array $arguments
* (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.
* @param 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.
* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
* (optional) The string translation service.
*
* @throws \InvalidArgumentException
* Exception thrown when $string is not a string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.
/**
* Gets the untranslated string value stored in this translated string.
*
* @return string
* The string stored in this wrapper.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
public getOption($name): mixed Gets a specific option from this translated string.
/**
* Gets a specific option from this translated string.
*
* @param string $name
* Option name.
*
* @return mixed
* The value of this option or empty string of option is not set.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
public getOptions(): mixed[] Gets all options from this translated string.
/**
* Gets all options from this translated string.
*
* @return mixed[]
* The array of options.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
public getArguments(): mixed[] Gets all arguments from this translated string.
/**
* Gets all arguments from this translated string.
*
* @return mixed[]
* The array of arguments.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
public render(): string Renders the object as a string.
/**
* Renders the object as a string.
*
* @return string
* The translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
public __sleep(): array Magic __sleep() method to avoid serializing the string translator.
/**
* Magic __sleep() method to avoid serializing the string translator.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
public count(): int Returns the string length.
/**
* Returns the string length.
*
* @return int
* The length of the string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
public __toString(): string Implements the magic __toString() method.
/**
* Implements the magic __toString() method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.
/**
* Returns a representation of the object for use in JSON serialization.
*
* @return string
* The safe string content.
*/
Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97
protected _die() For test purposes, wrap die() in an overridable method.
/**
* For test purposes, wrap die() in an overridable method.
*/
Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.
/**
* Replaces placeholders in a string with values.
*
* For convenience examples are listed here. Refer to the parameter
* description for $args for details of the placeholders "@", "%", and ":".
*
* Secure examples.
* @code
* // Return the HTML string "Prefix $some_variable".
* $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
* // Convert an object to a sanitized string.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
* // Wrap $some_variable in an <em> tag.
* $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
* // The following are using the : placeholder inside an HTML tag.
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
* $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
* // Use a : placeholder inside an HTML tag.
* $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
* @endcode
* The above are typical examples of using the placeholders correctly.
*
* Insecure examples.
* @code
* // The following are using the @ placeholder inside an HTML tag.
* $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
* $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
* // Implicitly convert an object to a string, which is not sanitized.
* $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
* @endcode
* These are the more common mistakes that can be made. Make sure that your
* site is not using any insecure usages of these placeholders.
*
* @param string $string
* A string containing placeholders. The string itself is expected to be
* safe and correct HTML. Any unsafe content must be in $args and inserted
* via placeholders. It is insecure to use the @ or % placeholders within
* the "<" and ">" of an HTML tag.
* @param array $args
* An associative array of replacements. Each array key should be the same
* as a placeholder in $string. The corresponding value should be a string
* or an object that implements \Drupal\Component\Render\MarkupInterface.
* The args[] value replaces the placeholder in $string. Sanitization and
* formatting will be done before replacement. The type of sanitization
* and formatting depends on the first character of the key:
* - @variable: Use as the default choice for anything displayed on the
* site. Do not use within the "<" and ">" of an HTML tag, such as in
* HTML attribute values. Doing so is a security risk.
* - %variable: Use when @variable would be appropriate, but you want the
* placeholder value to be wrapped in an <em> tag with a placeholder
* class. As with @variable, do not use within the "<" and ">" of an HTML
* tag, such as in HTML attribute values. Doing so is a security risk.
* - :variable: Use when the return value is to be used as a URL value of an
* HTML attribute. Only the "href" attribute is supported. The return
* value is escaped with
* \Drupal\Component\Utility\Html::escape() and filtered for dangerous
* protocols using UrlHelper::stripDangerousProtocols(). Use this when
* using the "href" attribute, ensuring the value is always wrapped in
* quotes.
*
* @return string
* A formatted HTML string with the placeholders replaced.
*
* @ingroup sanitization
*
* @see \Drupal\Core\StringTranslation\TranslatableMarkup
* @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @see \Drupal\Component\Utility\Html::escape()
* @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
* @see \Drupal\Core\Url::fromUri()
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175
protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.
/**
* Escapes a placeholder replacement value if needed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $value
* A placeholder replacement value.
*
* @return string
* The properly escaped replacement value.
*/
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:21
public getConfigDependencyKey() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:37
protected checkStorageClass($class) {@inheritdoc}
/**
* {@inheritdoc}
*
* @throws \InvalidArgumentException
* If the provided class does not implement
* \Drupal\Core\Entity\ContentEntityStorageInterface.
*
* @see \Drupal\Core\Entity\ContentEntityStorageInterface
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:50
public getRevisionMetadataKeys() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:60
public getRevisionMetadataKey($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:67
public hasRevisionMetadataKey($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:75
public setRevisionMetadataKey($key, $field_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityType.php:83
public get($property) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:381
public set($property, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:394
public isInternal() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:410
public isStaticallyCacheable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:417
public isRenderCacheable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:424
public isPersistentlyCacheable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:431
public getKeys() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:438
public getKey($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:445
public hasKey($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:453
public getOriginalClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:461
public getDecoratedClasses(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:468
public setClass($class) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:475
public entityClassImplements($interface) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:491
public getHandlerClasses() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:498
public getHandlerClass($handler_type, $nested = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:505
public setHandlerClass($handler_type, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:516
public hasHandlerClass($handler_type, $nested = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:524
public getStorageClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:539
public setStorageClass($class) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:546
public getFormClass($operation) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:565
public setFormClass($operation, $class) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:572
public hasFormClasses() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:580
public hasRouteProviders() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:587
public getListBuilderClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:594
public setListBuilderClass($class) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:601
public hasListBuilderClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:609
public getViewBuilderClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:616
public setViewBuilderClass($class) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:623
public hasViewBuilderClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:631
public getRouteProviderClasses() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:638
public getAccessControlClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:645
public setAccessClass($class) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:652
public getAdminPermission() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:660
public getCollectionPermission(): ?string {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:667
public getPermissionGranularity() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:674
public getLinkTemplates() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:681
public getLinkTemplate($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:688
public hasLinkTemplate($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:696
public setLinkTemplate($key, $path) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:704
public getBundleEntityType() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:716
public getBundleOf() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:723
public getBundleLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:730
public getBaseTable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:745
public showRevisionUi() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:752
public isTranslatable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:759
public isRevisionable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:766
public getRevisionDataTable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:774
public getRevisionTable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:781
public getDataTable() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:788
public getLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:795
public getCollectionLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:802
public getSingularLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:813
public getPluralLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:824
public getCountLabel($count) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:835
public getUriCallback() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:849
public setUriCallback($callback) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:856
public getGroup() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:864
public getGroupLabel() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:871
public getListCacheContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:878
public getListCacheTags() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:885
public getBundleListCacheTags(string $bundle): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:892
public isCommonReferenceTarget() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:909
public getConstraints() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:916
public setConstraints(array $constraints) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:923
public addConstraint($constraint_name, $options = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:931
public getBundleConfigDependency($bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityType.php:939
public id() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Plugin\Definition\PluginDefinition
Defined in <drupal>/core/lib/Drupal/Component/Plugin/Definition/PluginDefinition.php:35
public getClass() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Plugin\Definition\PluginDefinition
Defined in <drupal>/core/lib/Drupal/Component/Plugin/Definition/PluginDefinition.php:50
public getProvider() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Component\Plugin\Definition\PluginDefinition
Defined in <drupal>/core/lib/Drupal/Component/Plugin/Definition/PluginDefinition.php:57
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Inherited from Drupal\Core\Entity\EntityType
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public const Drupal\Core\Entity\EntityTypeInterface::ID_MAX_LENGTH :: integer 32
public const Drupal\Core\Entity\EntityTypeInterface::BUNDLE_MAX_LENGTH :: integer 32
protected language -> Drupal\Core\Language\Language#209 Depth Limit
public __construct(array $values) Constructs the default language object.
/**
* Constructs the default language object.
*
* @param array $values
* The properties used to construct the default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:30
public get(): \Drupal\Core\Language\LanguageInterface Gets the default language.
/**
* Gets the default language.
*
* @return \Drupal\Core\Language\LanguageInterface
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:40
public set(Drupal\Core\Language\LanguageInterface $language) Sets the default language.
/**
* Sets the default language.
*
* @param \Drupal\Core\Language\LanguageInterface $language
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:50
public __construct(Drupal\Core\Language\LanguageDefault $default_language) Constructs the language manager.
/**
* Constructs the language manager.
*
* @param \Drupal\Core\Language\LanguageDefault $default_language
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:46
public isMultilingual() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:53
public getLanguageTypes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:60
public getDefinedLanguageTypesInfo(): array Returns information about all defined language types.
/**
* Returns information about all defined language types.
*
* Defines the three core language types:
* - Interface language is the only configurable language type in core. It is
* used by t() as the default language if none is specified.
* - Content language is by default non-configurable and inherits the
* interface language negotiated value. It is used by the Field API to
* determine the display language for fields if no explicit value is
* specified.
* - URL language is by default non-configurable and is determined through the
* URL language negotiation method or the URL fallback language negotiation
* method if no language can be detected. It is used by l() as the default
* language if none is specified.
*
* @return array
* An associative array of language type information arrays keyed by
* language type machine name, in the format of
* hook_language_types_info().
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:84
public getCurrentLanguage($type = 'language_interface') {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:107
public reset($type = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:114
public getDefaultLanguage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:121
public getLanguages($flags = 1) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:128
public getNativeLanguages() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:147
public getLanguage($langcode) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:155
public getLanguageName($langcode) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:163
public getDefaultLockedLanguages($weight = 0) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:179
public isLanguageLocked($langcode) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:207
public getFallbackCandidates(array $context = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:215
public getLanguageSwitchLinks($type, Drupal\Core\Url $url) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:222
public setConfigOverrideLanguage(?Drupal\Core\Language\LanguageInterface $language = null): $this Sets the configuration override language.
/**
* Sets the configuration override language.
*
* This function is a noop since the configuration cannot be overridden by
* language unless the Language module is enabled. That replaces the default
* language manager with a configurable language manager.
*
* @param \Drupal\Core\Language\LanguageInterface $language
* The language to override configuration with.
*
* @return $this
*
* @see \Drupal\language\ConfigurableLanguageManager::setConfigOverrideLanguage()
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:387
public getConfigOverrideLanguage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:394
protected filterLanguages(array $languages, $flags = 1): \Drupal\Core\Language\LanguageInterface[] Filters the full list of languages based on the value of the flag.
/**
* Filters the full list of languages based on the value of the flag.
*
* The locked languages are removed by default.
*
* @param \Drupal\Core\Language\LanguageInterface[] $languages
* Array with languages to be filtered.
* @param int $flags
* (optional) Specifies the state of the languages that have to be returned.
* It can be: LanguageInterface::STATE_CONFIGURABLE,
* LanguageInterface::STATE_LOCKED, or LanguageInterface::STATE_ALL.
*
* @return \Drupal\Core\Language\LanguageInterface[]
* An associative array of languages, keyed by the language code.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:413
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
public static Drupal\Core\Language\LanguageManager::getStandardLanguageList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:229
public static Drupal\Core\Language\LanguageManager::getUnitedNationsLanguageList(): array The 6 official languages used at the United Nations.
/**
* The 6 official languages used at the United Nations.
*
* This list is based on https://www.un.org/en/our-work/official-languages
* and it uses the same format as getStandardLanguageList().
*
* @return array
* An array with language codes as keys, and English and native language
* names as values.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:360
public __construct(Symfony\Component\DependencyInjection\ContainerInterface $container, array $context_provider_service_ids) Constructs a LazyContextRepository object.
/**
* Constructs a LazyContextRepository object.
*
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
* The current service container.
* @param string[] $context_provider_service_ids
* The set of the available context provider service IDs.
*/
Defined in <drupal>/core/lib/Drupal/Core/Plugin/Context/LazyContextRepository.php:42
public getRuntimeContexts(array $context_ids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Plugin/Context/LazyContextRepository.php:50
public getAvailableContexts() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Plugin/Context/LazyContextRepository.php:86
public __construct(Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager, Drupal\Core\Language\LanguageManagerInterface $language_manager, Drupal\Core\Plugin\Context\ContextRepositoryInterface $context_repository) Constructs a new EntityRepository.
/**
* Constructs a new EntityRepository.
*
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
* @param \Drupal\Core\Plugin\Context\ContextRepositoryInterface $context_repository
* The context repository service.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:48
public loadEntityByUuid($entity_type_id, $uuid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:57
public loadEntityByConfigTarget($entity_type_id, $target) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:72
public getTranslationFromContext(Drupal\Core\Entity\EntityInterface $entity, $langcode = null, $context = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:94
public getActive($entity_type_id, $entity_id, ?array $contexts = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:130
public getActiveMultiple($entity_type_id, array $entity_ids, ?array $contexts = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:137
public getCanonical($entity_type_id, $entity_id, ?array $contexts = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:174
public getCanonicalMultiple($entity_type_id, array $entity_ids, ?array $contexts = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:181
protected getContentLanguageFromContexts(array $contexts): string|null Retrieves the current content language from the specified contexts.
/**
* Retrieves the current content language from the specified contexts.
*
* This is a BC layer to support plugin context system identifiers, the
* langcode key should be used instead and is preferred when given.
*
* @param string[] $contexts
* An array of context items.
*
* @return string|null
* A language code or NULL if no language context was provided.
*
* @internal
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:222
protected getLatestTranslationAffectedRevision(Drupal\Core\Entity\RevisionableInterface $entity, $langcode): \Drupal\Core\Entity\RevisionableInterface Returns the latest revision translation of the specified entity.
/**
* Returns the latest revision translation of the specified entity.
*
* @param \Drupal\Core\Entity\RevisionableInterface $entity
* The default revision of the entity being converted.
* @param string $langcode
* The language of the revision translation to be loaded.
*
* @return \Drupal\Core\Entity\RevisionableInterface
* The latest translation-affecting revision for the specified entity, or
* just the latest revision, if the specified entity is not translatable or
* does not have a matching translation yet.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:253
protected loadRevision(Drupal\Core\Entity\RevisionableInterface $entity, $revision_id): \Drupal\Core\Entity\RevisionableInterface Loads the specified entity revision.
/**
* Loads the specified entity revision.
*
* @param \Drupal\Core\Entity\RevisionableInterface $entity
* The default revision of the entity being converted.
* @param string $revision_id
* The identifier of the revision to be loaded.
*
* @return \Drupal\Core\Entity\RevisionableInterface
* An entity revision object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityRepository.php:299
public const Drupal\Core\Entity\EntityRepositoryInterface::CONTEXT_ID_LEGACY_CONTEXT_OPERATION :: string (43) "@entity.repository:legacy_context_operation"
protected language -> Drupal\Core\Language\Language#209 Depth Limit
public __construct(array $values) Constructs the default language object.
/**
* Constructs the default language object.
*
* @param array $values
* The properties used to construct the default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:30
public get(): \Drupal\Core\Language\LanguageInterface Gets the default language.
/**
* Gets the default language.
*
* @return \Drupal\Core\Language\LanguageInterface
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:40
public set(Drupal\Core\Language\LanguageInterface $language) Sets the default language.
/**
* Sets the default language.
*
* @param \Drupal\Core\Language\LanguageInterface $language
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:50
public __construct(Drupal\Core\Language\LanguageDefault $default_language) Constructs the language manager.
/**
* Constructs the language manager.
*
* @param \Drupal\Core\Language\LanguageDefault $default_language
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:46
public isMultilingual() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:53
public getLanguageTypes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:60
public getDefinedLanguageTypesInfo(): array Returns information about all defined language types.
/**
* Returns information about all defined language types.
*
* Defines the three core language types:
* - Interface language is the only configurable language type in core. It is
* used by t() as the default language if none is specified.
* - Content language is by default non-configurable and inherits the
* interface language negotiated value. It is used by the Field API to
* determine the display language for fields if no explicit value is
* specified.
* - URL language is by default non-configurable and is determined through the
* URL language negotiation method or the URL fallback language negotiation
* method if no language can be detected. It is used by l() as the default
* language if none is specified.
*
* @return array
* An associative array of language type information arrays keyed by
* language type machine name, in the format of
* hook_language_types_info().
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:84
public getCurrentLanguage($type = 'language_interface') {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:107
public reset($type = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:114
public getDefaultLanguage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:121
public getLanguages($flags = 1) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:128
public getNativeLanguages() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:147
public getLanguage($langcode) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:155
public getLanguageName($langcode) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:163
public getDefaultLockedLanguages($weight = 0) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:179
public isLanguageLocked($langcode) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:207
public getFallbackCandidates(array $context = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:215
public getLanguageSwitchLinks($type, Drupal\Core\Url $url) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:222
public setConfigOverrideLanguage(?Drupal\Core\Language\LanguageInterface $language = null): $this Sets the configuration override language.
/**
* Sets the configuration override language.
*
* This function is a noop since the configuration cannot be overridden by
* language unless the Language module is enabled. That replaces the default
* language manager with a configurable language manager.
*
* @param \Drupal\Core\Language\LanguageInterface $language
* The language to override configuration with.
*
* @return $this
*
* @see \Drupal\language\ConfigurableLanguageManager::setConfigOverrideLanguage()
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:387
public getConfigOverrideLanguage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:394
protected filterLanguages(array $languages, $flags = 1): \Drupal\Core\Language\LanguageInterface[] Filters the full list of languages based on the value of the flag.
/**
* Filters the full list of languages based on the value of the flag.
*
* The locked languages are removed by default.
*
* @param \Drupal\Core\Language\LanguageInterface[] $languages
* Array with languages to be filtered.
* @param int $flags
* (optional) Specifies the state of the languages that have to be returned.
* It can be: LanguageInterface::STATE_CONFIGURABLE,
* LanguageInterface::STATE_LOCKED, or LanguageInterface::STATE_ALL.
*
* @return \Drupal\Core\Language\LanguageInterface[]
* An associative array of languages, keyed by the language code.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:413
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
public static Drupal\Core\Language\LanguageManager::getStandardLanguageList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:229
public static Drupal\Core\Language\LanguageManager::getUnitedNationsLanguageList(): array The 6 official languages used at the United Nations.
/**
* The 6 official languages used at the United Nations.
*
* This list is based on https://www.un.org/en/our-work/official-languages
* and it uses the same format as getStandardLanguageList().
*
* @return array
* An array with language codes as keys, and English and native language
* names as values.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:360
protected time -> Drupal\Component\Datetime\Time#613 Depth Limit
public __construct(Drupal\Core\Database\Connection $connection, Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider, $bin, Drupal\Component\Serialization\ObjectAwareSerializationInterface $serializer, Drupal\Component\Datetime\TimeInterface $time, $max_rows = null) Constructs a DatabaseBackend object.
/**
* Constructs a DatabaseBackend object.
*
* @param \Drupal\Core\Database\Connection $connection
* The database connection.
* @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
* The cache tags checksum provider.
* @param string $bin
* The cache bin for which the object is created.
* @param \Drupal\Component\Serialization\ObjectAwareSerializationInterface|int|string|null $serializer
* (optional) The serializer to use.
* @param \Drupal\Component\Datetime\TimeInterface|int|string|null $time
* The time service.
* @param int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:88
public get($cid, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:108
public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:117
protected prepareItem($cache, $allow_invalid): mixed|false Prepares a cached item.
/**
* Prepares a cached item.
*
* Checks that items are either permanent or did not expire, and unserializes
* data as appropriate.
*
* @param object $cache
* An item loaded from self::get() or self::getMultiple().
* @param bool $allow_invalid
* If FALSE, the method returns FALSE if the cache item is not valid.
*
* @return mixed|false
* The item with data unserialized as appropriate and a property indicating
* whether the item is valid, or FALSE if there is no valid item to load.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:176
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:206
public setMultiple(array $items) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:219
protected doSetMultiple(array $items) Stores multiple items in the persistent cache.
/**
* Stores multiple items in the persistent cache.
*
* @param array $items
* An array of cache items, keyed by cid.
*
* @see \Drupal\Core\Cache\CacheBackendInterface::setMultiple()
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:247
public delete($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:315
public deleteMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:322
public deleteAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:345
public invalidate($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:362
public invalidateMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:369
public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:389
public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:404
public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:437
protected ensureBinExists() Check if the cache bin exists and create it if not.
/**
* Check if the cache bin exists and create it if not.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:449
protected catchException(Exception $e, $table_name = null) Act on an exception when cache might be stale.
/**
* Act on an exception when cache might be stale.
*
* If the table does not yet exist, that's fine, but if the table exists and
* yet the query failed, then the cache is stale and the exception needs to
* propagate.
*
* @param \Exception $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:481
protected normalizeCid($cid): string Normalizes a cache ID in order to comply with database limitations.
/**
* Normalizes a cache ID in order to comply with database limitations.
*
* @param string $cid
* The passed in cache ID.
*
* @return string
* An ASCII-encoded cache ID that is at most 255 characters long.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:496
public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:519
public getMaxRows(): int Gets the maximum number of rows for this cache bin table.
/**
* Gets the maximum number of rows for this cache bin table.
*
* @return int
* The maximum number of rows that this cache bin table is allowed to store.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:587
public const Drupal\Core\Cache\DatabaseBackend::DEFAULT_MAX_ROWS :: integer 5000
public const Drupal\Core\Cache\DatabaseBackend::MAXIMUM_NONE :: integer -1
public const Drupal\Core\Cache\DatabaseBackend::MAX_ITEMS_PER_CACHE_SET :: integer 100
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1
protected time -> Drupal\Component\Datetime\Time#613 Depth Limit
public __construct($bin, $site_prefix, Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider, Drupal\Component\Datetime\TimeInterface $time) Constructs a new ApcuBackend instance.
/**
* Constructs a new ApcuBackend instance.
*
* @param string $bin
* The name of the cache bin.
* @param string $site_prefix
* The prefix to use for all keys in the storage that belong to this site.
* @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
* The cache tags checksum provider.
* @param \Drupal\Component\Datetime\TimeInterface|null $time
* The time service.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:55
public getApcuKey($cid): string Prepends the APCu user variable prefix for this bin to a cache item ID.
/**
* Prepends the APCu user variable prefix for this bin to a cache item ID.
*
* @param string $cid
* The cache item ID to prefix.
*
* @return string
* The APCu key for the cache item ID.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:76
public get($cid, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:83
public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:91
protected getAll($prefix = ''): \APCUIterator Returns all cached items, optionally limited by a cache ID prefix.
/**
* Returns all cached items, optionally limited by a cache ID prefix.
*
* APCu is a memory cache, shared across all server processes. To prevent
* cache item clashes with other applications/installations, every cache item
* is prefixed with a unique string for this site. Therefore, functions like
* apcu_clear_cache() cannot be used, and instead, a list of all cache items
* belonging to this application need to be retrieved through this method
* instead.
*
* @param string $prefix
* (optional) A cache ID prefix to limit the result to.
*
* @return \APCUIterator
* An APCUIterator containing matched items.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:142
protected prepareItem($cache, $allow_invalid): mixed Prepares a cached item.
/**
* Prepares a cached item.
*
* Checks that the item is either permanent or did not expire.
*
* @param object $cache
* An item loaded from self::get() or self::getMultiple().
* @param bool $allow_invalid
* If TRUE, a cache item may be returned even if it is expired or has been
* invalidated. See ::get().
*
* @return mixed
* The cache item or FALSE if the item expired.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:160
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:185
public setMultiple(array $items = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:205
public delete($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:214
public deleteMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:221
public deleteAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:228
public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:235
public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:242
public invalidate($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:249
public invalidateMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:256
public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:265
protected getIterator($search = null, $format = 4294967295, $chunk_size = 100, $list = 1): \APCUIterator Instantiates and returns the APCUIterator class.
/**
* Instantiates and returns the APCUIterator class.
*
* @param mixed $search
* A PCRE regular expression that matches against APC key names, either as a
* string for a single regular expression, or as an array of regular
* expressions. Or, optionally pass in NULL to skip the search.
* @param int $format
* The desired format, as configured with one or more of the APC_ITER_*
* constants.
* @param int $chunk_size
* The chunk size. Must be a value greater than 0. The default value is 100.
* @param int $list
* The type to list. Either pass in APC_LIST_ACTIVE or APC_LIST_DELETED.
*
* @return \APCUIterator
* An APCUIterator class.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:291
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1
public __construct(Drupal\Core\Cache\CacheBackendInterface $consistent_backend, Drupal\Core\Cache\CacheBackendInterface $fast_backend, $bin) Constructs a ChainedFastBackend object.
/**
* Constructs a ChainedFastBackend object.
*
* @param \Drupal\Core\Cache\CacheBackendInterface $consistent_backend
* The consistent cache backend.
* @param \Drupal\Core\Cache\CacheBackendInterface $fast_backend
* The fast cache backend.
* @param string $bin
* The cache bin for which the object is created.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:93
public get($cid, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:103
public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:112
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:204
public setMultiple(array $items) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:221
public delete($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:229
public deleteMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:237
public deleteAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:245
public invalidate($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:253
public invalidateMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:260
public invalidateTags(array $tags) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:268
public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:280
public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:288
public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:296
public reset()
/**
* @todo Document in https://www.drupal.org/node/2311945.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:304
protected getLastWriteTimestamp() Gets the last write timestamp.
/**
* Gets the last write timestamp.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:311
protected markAsOutdated() Marks the fast cache bin as outdated because of a write.
/**
* Marks the fast cache bin as outdated because of a write.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:322
public const Drupal\Core\Cache\ChainedFastBackend::LAST_WRITE_TIMESTAMP_PREFIX :: string (21) "last_write_timestamp_"
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1
protected useCaches -> boolean true
protected stringTranslation -> null
public __construct(Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Drupal\Core\Cache\CacheBackendInterface $cache_backend, Drupal\Core\Language\LanguageManagerInterface $language_manager) Constructs a new EntityDisplayRepository.
/**
* Constructs a new EntityDisplayRepository.
*
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* The cache backend.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:60
public getAllViewModes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:70
public getViewModes($entity_type_id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:77
public getAllFormModes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:84
public getFormModes($entity_type_id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:91
protected getAllDisplayModesByEntityType($display_type): array Gets the entity display mode info for all entity types.
/**
* Gets the entity display mode info for all entity types.
*
* @param string $display_type
* The display type to be retrieved. It can be "view_mode" or "form_mode".
*
* @return array
* The display mode info for all entity types.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:104
protected getDisplayModesByEntityType($display_type, $entity_type_id): array Gets the entity display mode info for a specific entity type.
/**
* Gets the entity display mode info for a specific entity type.
*
* @param string $display_type
* The display type to be retrieved. It can be "view_mode" or "form_mode".
* @param string $entity_type_id
* The entity type whose display mode info should be returned.
*
* @return array
* The display mode info for a specific entity type.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:140
public getViewModeOptions($entity_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:156
public getFormModeOptions($entity_type_id) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:163
public getViewModeOptionsByBundle($entity_type_id, $bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:170
public getFormModeOptionsByBundle($entity_type_id, $bundle) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:177
protected getDisplayModeOptions($display_type, $entity_type_id): array Gets an array of display mode options.
/**
* Gets an array of display mode options.
*
* @param string $display_type
* The display type to be retrieved. It can be "view_mode" or "form_mode".
* @param string $entity_type_id
* The entity type whose display mode options should be returned.
*
* @return array
* An array of display mode labels, keyed by the display mode ID.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:192
protected getDisplayModeOptionsByBundle($display_type, $entity_type_id, $bundle): array Returns an array of enabled display mode options by bundle.
/**
* Returns an array of enabled display mode options by bundle.
*
* @param string $display_type
* The display type to be retrieved. It can be "view_mode" or "form_mode".
* @param string $entity_type_id
* The entity type whose display mode options should be returned.
* @param string $bundle
* The name of the bundle.
*
* @return array
* An array of display mode labels, keyed by the display mode ID.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:213
public clearDisplayModeInfo() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:244
public getViewDisplay($entity_type, $bundle, $view_mode = 'default') {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:252
public getFormDisplay($entity_type, $bundle, $form_mode = 'default') {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityDisplayRepository.php:275
protected cacheGet($cid): object|false Fetches from the cache backend, respecting the use caches flag.
/**
* Fetches from the cache backend, respecting the use caches flag.
*
* @param string $cid
* The cache ID of the data to retrieve.
*
* @return object|false
* The cache item or FALSE on failure.
*
* @see \Drupal\Core\Cache\CacheBackendInterface::get()
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UseCacheBackendTrait.php:35
protected cacheSet($cid, $data, $expire = -1, array $tags = array()) Stores data in the persistent cache, respecting the use caches flag.
/**
* Stores data in the persistent cache, respecting the use caches flag.
*
* @param string $cid
* The cache ID of the data to store.
* @param mixed $data
* The data to store in the cache.
* Some storage engines only allow objects up to a maximum of 1MB in size to
* be stored by default. When caching large arrays or similar, take care to
* ensure $data does not exceed this size.
* @param int $expire
* One of the following values:
* - CacheBackendInterface::CACHE_PERMANENT: Indicates that the item should
* not be removed unless it is deleted explicitly.
* - A Unix timestamp: Indicates that the item will be considered invalid
* after this time, i.e. it will not be returned by get() unless
* $allow_invalid has been set to TRUE. When the item has expired, it may
* be permanently deleted by the garbage collector at any time.
* @param array $tags
* An array of tags to be stored with the cache item. These should normally
* identify objects used to build the cache item, which should trigger
* cache invalidation when updated. For example if a cached item represents
* a node, both the node ID and the author's user ID might be passed in as
* tags. For example, ['node' => [123], 'user' => [92]].
*
* @see \Drupal\Core\Cache\CacheBackendInterface::set()
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/UseCacheBackendTrait.php:69
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public const Drupal\Core\Entity\EntityDisplayRepositoryInterface::DEFAULT_DISPLAY_MODE :: string (7) "default"
protected language -> Drupal\Core\Language\Language#209 (5)
Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)
protected name -> string (7) "English"
protected id -> string (2) "en"
protected direction -> string (3) "ltr"
protected weight -> integer 0
protected locked -> boolean false
public __construct(array $values = array()) Constructs a new class instance.
/**
* Constructs a new class instance.
*
* @param array $values
* An array of property values, keyed by property name, used to construct
* the language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:77
public getName() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101
public getId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108
public getDirection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115
public getWeight() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122
public isDefault() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129
public isLocked() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136
public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.
/**
* Sort language objects.
*
* @param \Drupal\Core\Language\LanguageInterface[] $languages
* The array of language objects keyed by langcode.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146
protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.
/**
* Gets the default langcode.
*
* @return string
* The current default langcode.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173
public static Drupal\Core\Language\Language::$defaultValues :: array (5) Depth Limit
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SYSTEM :: string (6) "system"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED :: string (3) "und"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_APPLICABLE :: string (3) "zxx"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT :: string (9) "x-default"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SITE_DEFAULT :: string (12) "site_default"
public const Drupal\Core\Language\LanguageInterface::VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
public const Drupal\Core\Language\LanguageInterface::STATE_CONFIGURABLE :: integer 1
public const Drupal\Core\Language\LanguageInterface::STATE_LOCKED :: integer 2
public const Drupal\Core\Language\LanguageInterface::STATE_ALL :: integer 3
public const Drupal\Core\Language\LanguageInterface::STATE_SITE_DEFAULT :: integer 4
public const Drupal\Core\Language\LanguageInterface::TYPE_CONTENT :: string (16) "language_content"
public const Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE :: string (18) "language_interface"
public const Drupal\Core\Language\LanguageInterface::TYPE_URL :: string (12) "language_url"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_LTR :: string (3) "ltr"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_RTL :: string (3) "rtl"
public __construct(array $values) Constructs the default language object.
/**
* Constructs the default language object.
*
* @param array $values
* The properties used to construct the default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:30
public get(): \Drupal\Core\Language\LanguageInterface Gets the default language.
/**
* Gets the default language.
*
* @return \Drupal\Core\Language\LanguageInterface
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:40
public set(Drupal\Core\Language\LanguageInterface $language) Sets the default language.
/**
* Sets the default language.
*
* @param \Drupal\Core\Language\LanguageInterface $language
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageDefault.php:50
public __construct(Drupal\Core\Language\LanguageDefault $default_language) Constructs the language manager.
/**
* Constructs the language manager.
*
* @param \Drupal\Core\Language\LanguageDefault $default_language
* The default language.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:46
public isMultilingual() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:53
public getLanguageTypes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:60
public getDefinedLanguageTypesInfo(): array Returns information about all defined language types.
/**
* Returns information about all defined language types.
*
* Defines the three core language types:
* - Interface language is the only configurable language type in core. It is
* used by t() as the default language if none is specified.
* - Content language is by default non-configurable and inherits the
* interface language negotiated value. It is used by the Field API to
* determine the display language for fields if no explicit value is
* specified.
* - URL language is by default non-configurable and is determined through the
* URL language negotiation method or the URL fallback language negotiation
* method if no language can be detected. It is used by l() as the default
* language if none is specified.
*
* @return array
* An associative array of language type information arrays keyed by
* language type machine name, in the format of
* hook_language_types_info().
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:84
public getCurrentLanguage($type = 'language_interface') {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:107
public reset($type = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:114
public getDefaultLanguage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:121
public getLanguages($flags = 1) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:128
public getNativeLanguages() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:147
public getLanguage($langcode) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:155
public getLanguageName($langcode) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:163
public getDefaultLockedLanguages($weight = 0) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:179
public isLanguageLocked($langcode) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:207
public getFallbackCandidates(array $context = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:215
public getLanguageSwitchLinks($type, Drupal\Core\Url $url) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:222
public setConfigOverrideLanguage(?Drupal\Core\Language\LanguageInterface $language = null): $this Sets the configuration override language.
/**
* Sets the configuration override language.
*
* This function is a noop since the configuration cannot be overridden by
* language unless the Language module is enabled. That replaces the default
* language manager with a configurable language manager.
*
* @param \Drupal\Core\Language\LanguageInterface $language
* The language to override configuration with.
*
* @return $this
*
* @see \Drupal\language\ConfigurableLanguageManager::setConfigOverrideLanguage()
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:387
public getConfigOverrideLanguage() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:394
protected filterLanguages(array $languages, $flags = 1): \Drupal\Core\Language\LanguageInterface[] Filters the full list of languages based on the value of the flag.
/**
* Filters the full list of languages based on the value of the flag.
*
* The locked languages are removed by default.
*
* @param \Drupal\Core\Language\LanguageInterface[] $languages
* Array with languages to be filtered.
* @param int $flags
* (optional) Specifies the state of the languages that have to be returned.
* It can be: LanguageInterface::STATE_CONFIGURABLE,
* LanguageInterface::STATE_LOCKED, or LanguageInterface::STATE_ALL.
*
* @return \Drupal\Core\Language\LanguageInterface[]
* An associative array of languages, keyed by the language code.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:413
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
public static Drupal\Core\Language\LanguageManager::getStandardLanguageList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:229
public static Drupal\Core\Language\LanguageManager::getUnitedNationsLanguageList(): array The 6 official languages used at the United Nations.
/**
* The 6 official languages used at the United Nations.
*
* This list is based on https://www.un.org/en/our-work/official-languages
* and it uses the same format as getStandardLanguageList().
*
* @return array
* An array with language codes as keys, and English and native language
* names as values.
*/
Defined in <drupal>/core/lib/Drupal/Core/Language/LanguageManager.php:360
-rw-rw-r-- 33 33 5815 Jun 23 00:19 core/themes/engines/twig/twig.engine
prefix -> string (4) "twig"
status -> integer 1
required_by -> array (0)
requires -> array (0)
sort -> integer 0
module_dependencies -> array (0)
libraries -> array (1) Depth Limit
engine -> string (4) "twig"
public __construct($root, $type, $pathname, $filename = null) Constructs a new Extension object.
/**
* Constructs a new Extension object.
*
* @param string $root
* The app root.
* @param string $type
* The type of the extension; e.g., 'module'.
* @param string $pathname
* The relative path and filename of the extension's info file; e.g.,
* 'core/modules/node/node.info.yml'.
* @param string $filename
* (optional) The filename of the main extension file; e.g., 'node.module'.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:73
public getType(): string Returns the type of the extension.
/**
* Returns the type of the extension.
*
* @return string
* The extension type. This is usually 'module' or 'theme'.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:88
public getName(): string Returns the internal name of the extension.
/**
* Returns the internal name of the extension.
*
* @return string
* The machine name of the extension.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:98
public getPath(): string Returns the relative path of the extension.
/**
* Returns the relative path of the extension.
*
* @return string
* The relative path of the extension.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:108
public getPathname(): string Returns the relative path and filename of the extension's info file.
/**
* Returns the relative path and filename of the extension's info file.
*
* @return string
* The relative path and filename of the extension's .info file.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:118
public getFilename(): string Returns the filename of the extension's info file.
/**
* Returns the filename of the extension's info file.
*
* @return string
* The base name of the extension .info file.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:128
public getExtensionPathname(): string|null Returns the relative path of the main extension file, if any.
/**
* Returns the relative path of the main extension file, if any.
*
* @return string|null
* The relative path for the main extension file, usually the *.module file.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:138
public getExtensionFilename(): string|null Returns the name of the main extension file, if any.
/**
* Returns the name of the main extension file, if any.
*
* @return string|null
* The filename of the main extension file, usually the *.module file.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:150
public load(): bool Loads the main extension file, if any.
/**
* Loads the main extension file, if any.
*
* @return bool
* TRUE if this extension has a main extension file, FALSE otherwise.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:160
public getFileInfo(): SplFileInfo Returns SplFileInfo instance for the extension's info file.
/**
* Returns SplFileInfo instance for the extension's info file.
*
* @return \SplFileInfo
* The object to access a file information of info file.
*
* @see https://www.php.net/manual/class.splfileinfo.php
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:176
public __sleep(): array Magic method implementation to serialize the extension object.
/**
* Magic method implementation to serialize the extension object.
*
* @return array
* The names of all variables that should be serialized.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:189
public __wakeup(): void Magic method implementation to unserialize the extension object.
/**
* Magic method implementation to unserialize the extension object.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:202
public isExperimental(): bool Checks if an extension is marked as experimental.
/**
* Checks if an extension is marked as experimental.
*
* @return bool
* TRUE if an extension is marked as experimental, FALSE otherwise.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:219
public isObsolete(): bool Checks if an extension is marked as obsolete.
/**
* Checks if an extension is marked as obsolete.
*
* @return bool
* TRUE if an extension is marked as obsolete, FALSE otherwise.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/Extension.php:230
public __construct(array $values) Constructs an ActiveTheme object.
/**
* Constructs an ActiveTheme object.
*
* @param array $values
* The properties of the object, keyed by the names.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:99
public getName(): string Returns the machine name of the theme.
/**
* Returns the machine name of the theme.
*
* @return string
* The machine name for the theme.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:132
public getPath(): string Returns the path to the theme directory.
/**
* Returns the path to the theme directory.
*
* @return string
* The file path of the theme directory.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:142
public getEngine(): string Returns the theme engine.
/**
* Returns the theme engine.
*
* @return string
* The engine of the theme.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:152
public getOwner(): mixed Returns the path to the theme engine for root themes.
/**
* Returns the path to the theme engine for root themes.
*
* @return mixed
* The path to the theme engine for root themes.
*
* @see \Drupal\Core\Extension\ThemeExtensionList::doList()
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:164
public getExtension(): \Drupal\Core\Extension\Extension Returns the extension object.
/**
* Returns the extension object.
*
* @return \Drupal\Core\Extension\Extension
* The extension object for the theme.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:175
public getLibraries(): mixed Returns the libraries provided by the theme.
/**
* Returns the libraries provided by the theme.
*
* @return mixed
* The libraries provided by the theme.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:185
public getBaseThemeExtensions(): \Drupal\Core\Extension\Extension[] Returns an array of base theme extension objects keyed by name.
/**
* Returns an array of base theme extension objects keyed by name.
*
* The order starts with the base theme of $this and ends with the root of
* the dependency chain. For most use cases, parent themes are expected to
* be called first, so this order needs to be reversed with array_reverse()
*
* @return \Drupal\Core\Extension\Extension[]
* An array of base theme extension objects keyed by name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:199
public getLogo(): string Returns the logo provided by the theme.
/**
* Returns the logo provided by the theme.
*
* @return string
* The logo path.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:209
public getRegions(): string[] The regions used by the theme.
/**
* The regions used by the theme.
*
* @return string[]
* The list of region machine names supported by the theme.
*
* @see system_region_list()
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:221
public getLibrariesOverride(): array Returns the libraries or library assets overridden by the active theme.
/**
* Returns the libraries or library assets overridden by the active theme.
*
* @return array
* The list of libraries overrides.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:231
public getLibrariesExtend(): array Returns the libraries extended by the active theme.
/**
* Returns the libraries extended by the active theme.
*
* @return array
* The list of libraries-extend definitions.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:241
public __construct(Symfony\Component\DependencyInjection\ContainerInterface $container, $drupal_proxy_original_service_id) Constructs a ProxyClass Drupal proxy object.
/**
* Constructs a ProxyClass Drupal proxy object.
*
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
* The container.
* @param string $drupal_proxy_original_service_id
* The service ID of the original service.
*/
Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:49
protected lazyLoadItself(): object Lazy loads the real service from the container.
/**
* Lazy loads the real service from the container.
*
* @return object
* Returns the constructed real service.
*/
Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:61
public acquire($name, $timeout = 30.0) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:73
public lockMayBeAvailable($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:81
public release($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:89
public releaseAll($lock_id = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:97
public schemaDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:105
public wait($name, $delay = 30) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:113
public getLockId() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/ProxyClass/Lock/DatabaseLockBackend.php:121
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
public __construct(Drupal\Core\Database\Connection $connection) Constructs a DatabaseCacheTagsChecksum object.
/**
* Constructs a DatabaseCacheTagsChecksum object.
*
* @param \Drupal\Core\Database\Connection $connection
* The database connection.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:28
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:58
public purge(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:75
protected ensureTableExists() Check if the cache tags table exists and create it if not.
/**
* Check if the cache tags table exists and create it if not.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:91
public schemaDefinition() Defines the schema for the {cachetags} table.
/**
* Defines the schema for the {cachetags} table.
*
* @internal
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:113
public getDatabaseConnection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseCacheTagsChecksum.php:139
public rootTransactionEndCallback($success) Callback to be invoked just after a database transaction gets committed.
/**
* Callback to be invoked just after a database transaction gets committed.
*
* Executes all delayed tag invalidations.
*
* @param bool $success
* Whether or not the transaction was successful.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:48
public invalidateTags(array $tags) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:58
public getCurrentChecksum(array $tags) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:89
public isValid($checksum, array $tags) Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::isValid()
/**
* Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::isValid()
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:111
protected calculateChecksum(array $tags): int Calculates the current checksum for a given set of tags.
/**
* Calculates the current checksum for a given set of tags.
*
* @param string[] $tags
* The array of tags to calculate the checksum for.
*
* @return int
* The calculated checksum.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:139
public reset() Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::reset()
/**
* Implements \Drupal\Core\Cache\CacheTagsChecksumInterface::reset()
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:176
public registerCacheTagsForPreload(array $cache_tags): void Implements \Drupal\Core\Cache\CacheTagsChecksumPreloadInterface::registerCach...
/**
* Implements \Drupal\Core\Cache\CacheTagsChecksumPreloadInterface::registerCacheTagsForPreload()
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php:184
public const Drupal\Core\Cache\CacheTagsChecksumInterface::INVALID_CHECKSUM_WHILE_IN_TRANSACTION :: integer -1
public __construct(?Symfony\Component\HttpFoundation\RequestStack $request_stack = null) Constructs a Time object.
/**
* Constructs a Time object.
*
* @param \Symfony\Component\HttpFoundation\RequestStack|null $request_stack
* (Optional) The request stack.
*/
Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:34
public getRequestTime() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:41
public getRequestMicroTime() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:54
public getCurrentTime() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:67
public getCurrentMicroTime() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:74
protected getProxyRequestTime(): int Returns a mimic of the timestamp of the current request.
/**
* Returns a mimic of the timestamp of the current request.
*
* @return int
* A value returned by time().
*/
Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:84
protected getProxyRequestMicroTime(): float Returns a mimic of the timestamp of the current request.
/**
* Returns a mimic of the timestamp of the current request.
*
* @return float
* A value returned by microtime().
*/
Defined in <drupal>/core/lib/Drupal/Component/Datetime/Time.php:97
public __construct(Drupal\Core\Database\Connection $connection, Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider, $bin, Drupal\Component\Serialization\ObjectAwareSerializationInterface $serializer, Drupal\Component\Datetime\TimeInterface $time, $max_rows = null) Constructs a DatabaseBackend object.
/**
* Constructs a DatabaseBackend object.
*
* @param \Drupal\Core\Database\Connection $connection
* The database connection.
* @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
* The cache tags checksum provider.
* @param string $bin
* The cache bin for which the object is created.
* @param \Drupal\Component\Serialization\ObjectAwareSerializationInterface|int|string|null $serializer
* (optional) The serializer to use.
* @param \Drupal\Component\Datetime\TimeInterface|int|string|null $time
* The time service.
* @param int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:88
public get($cid, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:108
public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:117
protected prepareItem($cache, $allow_invalid): mixed|false Prepares a cached item.
/**
* Prepares a cached item.
*
* Checks that items are either permanent or did not expire, and unserializes
* data as appropriate.
*
* @param object $cache
* An item loaded from self::get() or self::getMultiple().
* @param bool $allow_invalid
* If FALSE, the method returns FALSE if the cache item is not valid.
*
* @return mixed|false
* The item with data unserialized as appropriate and a property indicating
* whether the item is valid, or FALSE if there is no valid item to load.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:176
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:206
public setMultiple(array $items) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:219
protected doSetMultiple(array $items) Stores multiple items in the persistent cache.
/**
* Stores multiple items in the persistent cache.
*
* @param array $items
* An array of cache items, keyed by cid.
*
* @see \Drupal\Core\Cache\CacheBackendInterface::setMultiple()
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:247
public delete($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:315
public deleteMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:322
public deleteAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:345
public invalidate($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:362
public invalidateMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:369
public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:389
public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:404
public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:437
protected ensureBinExists() Check if the cache bin exists and create it if not.
/**
* Check if the cache bin exists and create it if not.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:449
protected catchException(Exception $e, $table_name = null) Act on an exception when cache might be stale.
/**
* Act on an exception when cache might be stale.
*
* If the table does not yet exist, that's fine, but if the table exists and
* yet the query failed, then the cache is stale and the exception needs to
* propagate.
*
* @param \Exception $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:481
protected normalizeCid($cid): string Normalizes a cache ID in order to comply with database limitations.
/**
* Normalizes a cache ID in order to comply with database limitations.
*
* @param string $cid
* The passed in cache ID.
*
* @return string
* An ASCII-encoded cache ID that is at most 255 characters long.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:496
public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:519
public getMaxRows(): int Gets the maximum number of rows for this cache bin table.
/**
* Gets the maximum number of rows for this cache bin table.
*
* @return int
* The maximum number of rows that this cache bin table is allowed to store.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:587
public const Drupal\Core\Cache\DatabaseBackend::DEFAULT_MAX_ROWS :: integer 5000
public const Drupal\Core\Cache\DatabaseBackend::MAXIMUM_NONE :: integer -1
public const Drupal\Core\Cache\DatabaseBackend::MAX_ITEMS_PER_CACHE_SET :: integer 100
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1
public __construct($cid, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Lock\LockBackendInterface $lock, $tags = array(), $modules_loaded = false) Constructs a ThemeRegistry object.
/**
* Constructs a ThemeRegistry object.
*
* @param string $cid
* The cid for the array being cached.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache
* The cache backend.
* @param \Drupal\Core\Lock\LockBackendInterface $lock
* The lock backend.
* @param array $tags
* (optional) The tags to specify for the cache item.
* @param bool $modules_loaded
* Whether all modules have already been loaded.
*/
Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:53
public initializeRegistry(): array Initializes the full theme registry.
/**
* Initializes the full theme registry.
*
* @return array
* An array with the keys of the full theme registry, but the values
* initialized to NULL.
*/
Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:88
public has($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:98
public get($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:109
public resolveCacheMiss($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:124
protected updateCache($lock = true) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:138
public getPreprocessInvokes(): array Gets preprocess invoke map.
/**
* Gets preprocess invoke map.
*
* @return array
* An array of preprocess invokes for preprocess functions in modules.
*
* @internal
*/
Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:179
public getGlobalPreprocess(): array Gets global preprocess callbacks.
/**
* Gets global preprocess callbacks.
*
* @return array
* An array of preprocess callbacks that should be called for every theme
* hook.
*
* @internal
*/
Defined in <drupal>/core/lib/Drupal/Core/Utility/ThemeRegistry.php:192
protected getCid(): string Gets the cache ID.
/**
* Gets the cache ID.
*
* @return string
* The cache ID.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:127
public set($key, $value) Implements \Drupal\Core\Cache\CacheCollectorInterface::set().
/**
* Implements \Drupal\Core\Cache\CacheCollectorInterface::set().
*
* This is not persisted by default. In practice this means that setting a
* value will only apply while the object is in scope and will not be written
* back to the persistent cache. This follows a similar pattern to static vs.
* persistent caching in procedural code. Extending classes may wish to alter
* this behavior, for example by adding a call to persist(). If you are
* writing data to somewhere in addition to the cache item in ::set(), you
* should call static::updateCache() at the end of your ::set implementation.
* This avoids a race condition if another request starts with an empty cache
* before your ::set() call. For example: Drupal\Core\State\State.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:166
public delete($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:177
protected persist($key, $persist = true) Flags an offset value to be written to the persistent cache.
/**
* Flags an offset value to be written to the persistent cache.
*
* @param string $key
* The key that was requested.
* @param bool $persist
* (optional) Whether the offset should be persisted or not, defaults to
* TRUE. When called with $persist = FALSE the offset will be un-flagged so
* that it will not be written at the end of the request.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:196
public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:289
public clear() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:299
public destruct() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:312
protected lazyLoadCache() Loads the cache if not already done.
/**
* Loads the cache if not already done.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:319
protected invalidateCache() Invalidate the cache.
/**
* Invalidate the cache.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:335
public __construct($root, $type, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Extension\InfoParserInterface $info_parser, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Drupal\Core\State\StateInterface $state, Drupal\Core\Config\ConfigFactoryInterface $config_factory, Drupal\Core\Extension\ThemeEngineExtensionList $engine_list, $install_profile) Constructs a new ThemeExtensionList instance.
/**
* Constructs a new ThemeExtensionList instance.
*
* @param string $root
* The app root.
* @param string $type
* The extension type.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache
* The cache.
* @param \Drupal\Core\Extension\InfoParserInterface $info_parser
* The info parser.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\State\StateInterface $state
* The state service.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory.
* @param \Drupal\Core\Extension\ThemeEngineExtensionList $engine_list
* The theme engine extension listing.
* @param string $install_profile
* The install profile used by the site.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:101
protected doList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:111
protected fillInSubThemeData(array &$themes, array $sub_themes) Fills in data for themes that are also sub-themes.
/**
* Fills in data for themes that are also sub-themes.
*
* @param array $themes
* The array of partly processed theme information.
* @param array $sub_themes
* A list of themes from the $theme array that are also sub-themes.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:172
public getBaseThemes(array $themes, $theme): array Finds all the base themes for the specified theme.
/**
* Finds all the base themes for the specified theme.
*
* Themes can inherit templates and function implementations from earlier
* themes.
*
* @param \Drupal\Core\Extension\Extension[] $themes
* An array of available themes.
* @param string $theme
* The name of the theme whose base we are looking for.
*
* @return array
* Returns an array of all of the theme's ancestors; the first element's
* value will be NULL if an error occurred.
*
* @deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. There
* is no direct replacement.
*
* @see https://www.drupal.org/node/3413187
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:219
protected doGetBaseThemes(array $themes, $theme, array $used_themes = array()): array Finds the base themes for the specific theme.
/**
* Finds the base themes for the specific theme.
*
* @param array $themes
* An array of available themes.
* @param string $theme
* The name of the theme whose base we are looking for.
* @param array $used_themes
* (optional) A recursion parameter preventing endless loops. Defaults to
* an empty array.
*
* @return array
* An array of base themes.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:238
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:299
public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeExtensionList.php:310
protected getExtensionDiscovery(): \Drupal\Core\Extension\ExtensionDiscovery Returns the extension discovery.
/**
* Returns the extension discovery.
*
* @return \Drupal\Core\Extension\ExtensionDiscovery
* The extension discovery.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:153
protected getListCacheId(): string Returns the extension list cache ID.
/**
* Returns the extension list cache ID.
*
* @return string
* The list cache ID.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:193
protected getInfoCacheId(): string Returns the extension info cache ID.
/**
* Returns the extension info cache ID.
*
* @return string
* The info cache ID.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:203
protected getPathNamesCacheId(): string Returns the extension filenames cache ID.
/**
* Returns the extension filenames cache ID.
*
* @return string
* The filename cache ID.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:213
public exists($extension_name): bool Determines if an extension exists in the filesystem.
/**
* Determines if an extension exists in the filesystem.
*
* @param string $extension_name
* The machine name of the extension.
*
* @return bool
* TRUE if the extension exists (regardless installed or not) and FALSE if
* not.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:227
public getName($extension_name): string Returns the human-readable name of the extension.
/**
* Returns the human-readable name of the extension.
*
* @param string $extension_name
* The machine name of the extension.
*
* @return string
* The human-readable name of the extension.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:244
public get($extension_name): \Drupal\Core\Extension\Extension Returns a single extension.
/**
* Returns a single extension.
*
* @param string $extension_name
* The machine name of the extension.
*
* @return \Drupal\Core\Extension\Extension
* A processed extension object for the extension with the specified machine
* name.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:261
public getList(): \Drupal\Core\Extension\Extension[] Returns all available extensions.
/**
* Returns all available extensions.
*
* @return \Drupal\Core\Extension\Extension[]
* Processed extension objects, keyed by machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:276
protected doScanExtensions(): \Drupal\Core\Extension\Extension[] Scans the available extensions.
/**
* Scans the available extensions.
*
* Overriding this method gives other code the chance to add additional
* extensions to this raw listing.
*
* @return \Drupal\Core\Extension\Extension[]
* Unprocessed extension objects, keyed by machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:299
public getExtensionInfo($extension_name): mixed[] Returns information about a specified extension.
/**
* Returns information about a specified extension.
*
* This function returns the contents of the .info.yml file for the specified
* extension.
*
* @param string $extension_name
* The name of an extension whose information shall be returned.
*
* @return mixed[]
* An associative array of extension information.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:343
public getAllAvailableInfo(): array[] Returns an array of info files information of available extensions.
/**
* Returns an array of info files information of available extensions.
*
* This function returns the processed contents (with added defaults) of the
* .info.yml files.
*
* @return array[]
* An associative array of extension information arrays, keyed by extension
* name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:361
public getAllInstalledInfo(): array[] Returns an array of info files information of installed extensions.
/**
* Returns an array of info files information of installed extensions.
*
* This function returns the processed contents (with added defaults) of the
* .info.yml files.
*
* @return array[]
* An associative array of extension information arrays, keyed by extension
* name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:395
protected recalculateInfo(): array[] Generates the information from .info.yml files for extensions of this type.
/**
* Generates the information from .info.yml files for extensions of this type.
*
* @return array[]
* An array of arrays of .info.yml entries keyed by the machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:405
public getPathNames(): string[] Returns a list of extension file paths keyed by machine name.
/**
* Returns a list of extension file paths keyed by machine name.
*
* @return string[]
* An associative array of extension file paths, keyed by the extension
* machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:418
protected recalculatePathNames(): string[] Generates a sorted list of .info.yml file locations for all extensions.
/**
* Generates a sorted list of .info.yml file locations for all extensions.
*
* @return string[]
* An array of .info.yml file locations keyed by the extension machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:439
public setPathname($extension_name, $pathname) Sets the pathname for an extension.
/**
* Sets the pathname for an extension.
*
* This method is used in the Drupal bootstrapping phase, when the extension
* system is not fully initialized, to manually set locations of modules and
* profiles needed to complete bootstrapping.
*
* It is not recommended to call this method except in those rare cases.
*
* @param string $extension_name
* The machine name of the extension.
* @param string $pathname
* The pathname of the extension which is to be set explicitly rather
* than by consulting the dynamic extension listing.
*
* @internal
*
* @see ::getPathname
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:467
public getPathname($extension_name): string Gets the info file path for an extension.
/**
* Gets the info file path for an extension.
*
* The info path, whether provided, cached, or retrieved from the database, is
* only returned if the file exists.
*
* This function plays a key role in allowing Drupal's extensions (modules,
* themes, profiles, theme_engines, etc.) to be located in different places
* depending on a site's configuration. For example, a module 'foo' may
* legally be located in any of these four places:
*
* - core/modules/foo/foo.info.yml
* - modules/foo/foo.info.yml
* - sites/all/modules/foo/foo.info.yml
* - sites/example.com/modules/foo/foo.info.yml
*
* while a theme 'bar' may be located in any of the following four places:
*
* - core/themes/bar/bar.info.yml
* - themes/bar/bar.info.yml
* - sites/all/themes/bar/bar.info.yml
* - sites/example.com/themes/bar/bar.info.yml
*
* An installation profile maybe be located in any of the following places:
*
* - core/profiles/baz/baz.info.yml
* - profiles/baz/baz.info.yml
*
* Calling ExtensionList::getPathname('foo') will give you one of the above,
* depending on where the extension is located and what type it is.
*
* @param string $extension_name
* The machine name of the extension for which the pathname is requested.
*
* @return string
* The drupal-root relative filename and path of the requested extension's
* .info.yml file.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:512
public getPath($extension_name): string Gets the path to an extension of a specific type (module, theme, etc.).
/**
* Gets the path to an extension of a specific type (module, theme, etc.).
*
* The path is the directory in which the .info file is located. This name is
* coming from \SplFileInfo.
*
* @param string $extension_name
* The machine name of the extension for which the path is requested.
*
* @return string
* The Drupal-root-relative path to the specified extension.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:540
public checkIncompatibility($name): bool Tests the compatibility of an extension.
/**
* Tests the compatibility of an extension.
*
* @param string $name
* The extension name to check.
*
* @return bool
* TRUE if the extension is incompatible and FALSE if not.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:583
public static Drupal\Core\Extension\ExtensionList::sortByName(Drupal\Core\Extension\Extension $a, Drupal\Core\Extension\Extension $b): int Array sorting callback; sorts extensions by their name.
/**
* Array sorting callback; sorts extensions by their name.
*
* @param \Drupal\Core\Extension\Extension $a
* The first extension to compare.
* @param \Drupal\Core\Extension\Extension $b
* The second extension to compare.
*
* @return int
* Less than 0 if $a is less than $b, more than 0 if $a is greater than $b,
* and 0 if they are equal.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:600
public __construct($root, Drupal\Core\Config\ConfigFactoryInterface $config_factory, Drupal\Core\Extension\ThemeExtensionList $theme_list) Constructs a new ThemeHandler.
/**
* Constructs a new ThemeHandler.
*
* @param string $root
* The app root.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory to get the installed themes.
* @param \Drupal\Core\Extension\ThemeExtensionList $theme_list
* An extension discovery instance.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:51
public getDefault() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:60
public listInfo() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:67
public addTheme(Drupal\Core\Extension\Extension $theme) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:91
public refreshInfo() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:109
public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:123
public rebuildThemeData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:131
public getBaseThemes(array $themes, $theme) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:139
public getName($theme) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:147
public getThemeDirectories() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:154
public themeExists($theme) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:165
public getTheme($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:173
public hasUi($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:184
public __construct($root, Drupal\Core\Config\ConfigFactoryInterface $config_factory, Drupal\Core\Extension\ThemeExtensionList $theme_list) Constructs a new ThemeHandler.
/**
* Constructs a new ThemeHandler.
*
* @param string $root
* The app root.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory to get the installed themes.
* @param \Drupal\Core\Extension\ThemeExtensionList $theme_list
* An extension discovery instance.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:51
public getDefault() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:60
public listInfo() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:67
public addTheme(Drupal\Core\Extension\Extension $theme) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:91
public refreshInfo() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:109
public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:123
public rebuildThemeData() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:131
public getBaseThemes(array $themes, $theme) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:139
public getName($theme) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:147
public getThemeDirectories() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:154
public themeExists($theme) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:165
public getTheme($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:173
public hasUi($name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ThemeHandler.php:184
public __construct(Drupal\Core\Cache\CacheBackendInterface $consistent_backend, Drupal\Core\Cache\CacheBackendInterface $fast_backend, $bin) Constructs a ChainedFastBackend object.
/**
* Constructs a ChainedFastBackend object.
*
* @param \Drupal\Core\Cache\CacheBackendInterface $consistent_backend
* The consistent cache backend.
* @param \Drupal\Core\Cache\CacheBackendInterface $fast_backend
* The fast cache backend.
* @param string $bin
* The cache bin for which the object is created.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:93
public get($cid, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:103
public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:112
public __construct($root, Drupal\Core\Extension\ThemeHandlerInterface $theme_handler, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Psr\Container\ContainerInterface $themeEngines) Constructs a new ThemeInitialization object.
/**
* Constructs a new ThemeInitialization object.
*
* @param string $root
* The app root.
* @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
* The theme handler.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache
* The cache backend.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler to use to load modules.
* @param \Psr\Container\ContainerInterface $themeEngines
* The theme engines.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:67
public initTheme($theme_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:86
public getActiveThemeByName($theme_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:96
public loadActiveTheme(Drupal\Core\Theme\ActiveTheme $active_theme) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:143
public getActiveTheme(Drupal\Core\Extension\Extension $theme, array $base_themes = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:164
protected getExtensions(): array Gets all extensions.
/**
* Gets all extensions.
*
* @return array
* An associative array whose keys are the names of the extensions.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:271
public __construct(array $values) Constructs an ActiveTheme object.
/**
* Constructs an ActiveTheme object.
*
* @param array $values
* The properties of the object, keyed by the names.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:99
public getName(): string Returns the machine name of the theme.
/**
* Returns the machine name of the theme.
*
* @return string
* The machine name for the theme.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:132
public getPath(): string Returns the path to the theme directory.
/**
* Returns the path to the theme directory.
*
* @return string
* The file path of the theme directory.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:142
public getEngine(): string Returns the theme engine.
/**
* Returns the theme engine.
*
* @return string
* The engine of the theme.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:152
public getOwner(): mixed Returns the path to the theme engine for root themes.
/**
* Returns the path to the theme engine for root themes.
*
* @return mixed
* The path to the theme engine for root themes.
*
* @see \Drupal\Core\Extension\ThemeExtensionList::doList()
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:164
public getExtension(): \Drupal\Core\Extension\Extension Returns the extension object.
/**
* Returns the extension object.
*
* @return \Drupal\Core\Extension\Extension
* The extension object for the theme.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:175
public getLibraries(): mixed Returns the libraries provided by the theme.
/**
* Returns the libraries provided by the theme.
*
* @return mixed
* The libraries provided by the theme.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:185
public getBaseThemeExtensions(): \Drupal\Core\Extension\Extension[] Returns an array of base theme extension objects keyed by name.
/**
* Returns an array of base theme extension objects keyed by name.
*
* The order starts with the base theme of $this and ends with the root of
* the dependency chain. For most use cases, parent themes are expected to
* be called first, so this order needs to be reversed with array_reverse()
*
* @return \Drupal\Core\Extension\Extension[]
* An array of base theme extension objects keyed by name.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:199
public getLogo(): string Returns the logo provided by the theme.
/**
* Returns the logo provided by the theme.
*
* @return string
* The logo path.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:209
public getRegions(): string[] The regions used by the theme.
/**
* The regions used by the theme.
*
* @return string[]
* The list of region machine names supported by the theme.
*
* @see system_region_list()
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:221
public getLibrariesOverride(): array Returns the libraries or library assets overridden by the active theme.
/**
* Returns the libraries or library assets overridden by the active theme.
*
* @return array
* The list of libraries overrides.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:231
public getLibrariesExtend(): array Returns the libraries extended by the active theme.
/**
* Returns the libraries extended by the active theme.
*
* @return array
* The list of libraries-extend definitions.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ActiveTheme.php:241
public __construct(Drupal\Core\Theme\ThemeAccessCheck $theme_access, Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver, array $negotiators) Constructs a new ThemeNegotiator.
/**
* Constructs a new ThemeNegotiator.
*
* @param \Drupal\Core\Theme\ThemeAccessCheck $theme_access
* The access checker for themes.
* @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
* The class resolver.
* @param string[] $negotiators
* An array of negotiator IDs.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeNegotiator.php:47
public applies(Drupal\Core\Routing\RouteMatchInterface $route_match) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeNegotiator.php:56
public determineActiveTheme(Drupal\Core\Routing\RouteMatchInterface $route_match) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeNegotiator.php:63
public __construct($root, Drupal\Core\Extension\ThemeHandlerInterface $theme_handler, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Psr\Container\ContainerInterface $themeEngines) Constructs a new ThemeInitialization object.
/**
* Constructs a new ThemeInitialization object.
*
* @param string $root
* The app root.
* @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
* The theme handler.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache
* The cache backend.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler to use to load modules.
* @param \Psr\Container\ContainerInterface $themeEngines
* The theme engines.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:67
public initTheme($theme_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:86
public getActiveThemeByName($theme_name) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:96
public loadActiveTheme(Drupal\Core\Theme\ActiveTheme $active_theme) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:143
public getActiveTheme(Drupal\Core\Extension\Extension $theme, array $base_themes = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:164
protected getExtensions(): array Gets all extensions.
/**
* Gets all extensions.
*
* @return array
* An associative array whose keys are the names of the extensions.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeInitialization.php:271
public __construct(Drupal\Core\DependencyInjection\ClassResolverInterface $classResolver) Constructs a CallableResolver object.
/**
* Constructs a CallableResolver object.
*
* @param \Drupal\Core\DependencyInjection\ClassResolverInterface $classResolver
* The class resolver.
*/
Defined in <drupal>/core/lib/Drupal/Core/Utility/CallableResolver.php:45
public getCallableFromDefinition(callable|array|string $definition): callable Gets a callable from a definition.
/**
* Gets a callable from a definition.
*
* @param callable|array|string $definition
* A callable definition.
*
* @return callable
* A callable.
*
* @throws \InvalidArgumentException
* Thrown when no valid callable could be resolved from the definition.
*/
Defined in <drupal>/core/lib/Drupal/Core/Utility/CallableResolver.php:62
public __construct(Drupal\Core\Cache\CacheBackendInterface $consistent_backend, Drupal\Core\Cache\CacheBackendInterface $fast_backend, $bin) Constructs a ChainedFastBackend object.
/**
* Constructs a ChainedFastBackend object.
*
* @param \Drupal\Core\Cache\CacheBackendInterface $consistent_backend
* The consistent cache backend.
* @param \Drupal\Core\Cache\CacheBackendInterface $fast_backend
* The fast cache backend.
* @param string $bin
* The cache bin for which the object is created.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:93
public get($cid, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:103
public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:112
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:58
public setThemeRegistry(Drupal\Core\Theme\Registry $theme_registry): $this Sets the theme registry.
/**
* Sets the theme registry.
*
* @param \Drupal\Core\Theme\Registry $theme_registry
* The theme registry.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:89
public getActiveTheme(?Drupal\Core\Routing\RouteMatchInterface $route_match = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:97
public hasActiveTheme() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:107
public resetActiveTheme() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:114
public setActiveTheme(Drupal\Core\Theme\ActiveTheme $active_theme) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:123
public render($hook, array $variables) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:134
protected buildThemeHookSuggestions(string $hook, string $info_base_hook, array &$variables): array Builds theme hook suggestions for a theme hook with variables.
/**
* Builds theme hook suggestions for a theme hook with variables.
*
* @param string $hook
* Theme hook that was called.
* @param string $info_base_hook
* Theme registry info for $hook['base hook'] key or empty string.
* @param array $variables
* Theme variables that were passed along with the call.
*
* @return string[]
* Suggested theme hook names to use instead of $hook, in the order of
* ascending specificity.
* The caller will pick the last of those suggestions that has a known theme
* registry entry.
*
* @internal
* This method may change at any time. It is not for use outside this class.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:451
protected initTheme(?Drupal\Core\Routing\RouteMatchInterface $route_match = null) Initializes the active theme for a given route match.
/**
* Initializes the active theme for a given route match.
*
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
* The current route match.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:485
public invokeAllWith(string $hook, callable $callback): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:502
public invoke(string $theme, string $hook, array $args = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:517
/**
* {@inheritdoc}
*
* @todo Should we cache some of these information?
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:532
protected getImplementationsForTheme(string $theme_key, string $hook): array Gets a hook implementation list for a specific hook.
/**
* Gets a hook implementation list for a specific hook.
*
* @param string $theme_key
* The theme machine name.
* @param string $hook
* The hook name.
*
* @return array
* Array with hook implementations.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:578
protected getThemeChain(Drupal\Core\Theme\ActiveTheme $active_theme): array Gets theme and base themes in reverse order.
/**
* Gets theme and base themes in reverse order.
*
* @param \Drupal\Core\Theme\ActiveTheme $active_theme
* A manually specified theme.
*
* @return list<string>
* The list of theme keys with the active theme last.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:609
public alter($type, &$data, &$context1 = null, &$context2 = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:618
public getDefaultTemplateVariables(): array Returns default template variables.
/**
* Returns default template variables.
*
* These are set for every template before template preprocessing hooks.
*
* See the @link themeable Default theme implementations topic @endlink for
* details.
*
* @return array
* An array of default template variables.
*
* @internal
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:636
public getThemeEngine(string $name): ?Drupal\Core\Theme\ThemeEngineInterface {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/ThemeManager.php:661
protected time -> Drupal\Component\Datetime\Time#613 Depth Limit
public __construct(Drupal\Core\Database\Connection $connection, Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider, $bin, Drupal\Component\Serialization\ObjectAwareSerializationInterface $serializer, Drupal\Component\Datetime\TimeInterface $time, $max_rows = null) Constructs a DatabaseBackend object.
/**
* Constructs a DatabaseBackend object.
*
* @param \Drupal\Core\Database\Connection $connection
* The database connection.
* @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
* The cache tags checksum provider.
* @param string $bin
* The cache bin for which the object is created.
* @param \Drupal\Component\Serialization\ObjectAwareSerializationInterface|int|string|null $serializer
* (optional) The serializer to use.
* @param \Drupal\Component\Datetime\TimeInterface|int|string|null $time
* The time service.
* @param int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:88
public get($cid, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:108
public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:117
protected prepareItem($cache, $allow_invalid): mixed|false Prepares a cached item.
/**
* Prepares a cached item.
*
* Checks that items are either permanent or did not expire, and unserializes
* data as appropriate.
*
* @param object $cache
* An item loaded from self::get() or self::getMultiple().
* @param bool $allow_invalid
* If FALSE, the method returns FALSE if the cache item is not valid.
*
* @return mixed|false
* The item with data unserialized as appropriate and a property indicating
* whether the item is valid, or FALSE if there is no valid item to load.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:176
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:206
public setMultiple(array $items) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:219
protected doSetMultiple(array $items) Stores multiple items in the persistent cache.
/**
* Stores multiple items in the persistent cache.
*
* @param array $items
* An array of cache items, keyed by cid.
*
* @see \Drupal\Core\Cache\CacheBackendInterface::setMultiple()
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:247
public delete($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:315
public deleteMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:322
public deleteAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:345
public invalidate($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:362
public invalidateMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:369
public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:389
public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:404
public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:437
protected ensureBinExists() Check if the cache bin exists and create it if not.
/**
* Check if the cache bin exists and create it if not.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:449
protected catchException(Exception $e, $table_name = null) Act on an exception when cache might be stale.
/**
* Act on an exception when cache might be stale.
*
* If the table does not yet exist, that's fine, but if the table exists and
* yet the query failed, then the cache is stale and the exception needs to
* propagate.
*
* @param \Exception $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:481
protected normalizeCid($cid): string Normalizes a cache ID in order to comply with database limitations.
/**
* Normalizes a cache ID in order to comply with database limitations.
*
* @param string $cid
* The passed in cache ID.
*
* @return string
* An ASCII-encoded cache ID that is at most 255 characters long.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:496
public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:519
public getMaxRows(): int Gets the maximum number of rows for this cache bin table.
/**
* Gets the maximum number of rows for this cache bin table.
*
* @return int
* The maximum number of rows that this cache bin table is allowed to store.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:587
public const Drupal\Core\Cache\DatabaseBackend::DEFAULT_MAX_ROWS :: integer 5000
public const Drupal\Core\Cache\DatabaseBackend::MAXIMUM_NONE :: integer -1
public const Drupal\Core\Cache\DatabaseBackend::MAX_ITEMS_PER_CACHE_SET :: integer 100
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1
protected time -> Drupal\Component\Datetime\Time#613 Depth Limit
public __construct($bin, $site_prefix, Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider, Drupal\Component\Datetime\TimeInterface $time) Constructs a new ApcuBackend instance.
/**
* Constructs a new ApcuBackend instance.
*
* @param string $bin
* The name of the cache bin.
* @param string $site_prefix
* The prefix to use for all keys in the storage that belong to this site.
* @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
* The cache tags checksum provider.
* @param \Drupal\Component\Datetime\TimeInterface|null $time
* The time service.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:55
public getApcuKey($cid): string Prepends the APCu user variable prefix for this bin to a cache item ID.
/**
* Prepends the APCu user variable prefix for this bin to a cache item ID.
*
* @param string $cid
* The cache item ID to prefix.
*
* @return string
* The APCu key for the cache item ID.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:76
public get($cid, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:83
public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:91
protected getAll($prefix = ''): \APCUIterator Returns all cached items, optionally limited by a cache ID prefix.
/**
* Returns all cached items, optionally limited by a cache ID prefix.
*
* APCu is a memory cache, shared across all server processes. To prevent
* cache item clashes with other applications/installations, every cache item
* is prefixed with a unique string for this site. Therefore, functions like
* apcu_clear_cache() cannot be used, and instead, a list of all cache items
* belonging to this application need to be retrieved through this method
* instead.
*
* @param string $prefix
* (optional) A cache ID prefix to limit the result to.
*
* @return \APCUIterator
* An APCUIterator containing matched items.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:142
protected prepareItem($cache, $allow_invalid): mixed Prepares a cached item.
/**
* Prepares a cached item.
*
* Checks that the item is either permanent or did not expire.
*
* @param object $cache
* An item loaded from self::get() or self::getMultiple().
* @param bool $allow_invalid
* If TRUE, a cache item may be returned even if it is expired or has been
* invalidated. See ::get().
*
* @return mixed
* The cache item or FALSE if the item expired.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:160
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:185
public setMultiple(array $items = array()) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:205
public delete($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:214
public deleteMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:221
public deleteAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:228
public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:235
public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:242
public invalidate($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:249
public invalidateMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:256
public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:265
protected getIterator($search = null, $format = 4294967295, $chunk_size = 100, $list = 1): \APCUIterator Instantiates and returns the APCUIterator class.
/**
* Instantiates and returns the APCUIterator class.
*
* @param mixed $search
* A PCRE regular expression that matches against APC key names, either as a
* string for a single regular expression, or as an array of regular
* expressions. Or, optionally pass in NULL to skip the search.
* @param int $format
* The desired format, as configured with one or more of the APC_ITER_*
* constants.
* @param int $chunk_size
* The chunk size. Must be a value greater than 0. The default value is 100.
* @param int $list
* The type to list. Either pass in APC_LIST_ACTIVE or APC_LIST_DELETED.
*
* @return \APCUIterator
* An APCUIterator class.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ApcuBackend.php:291
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1
public __construct(Drupal\Core\Cache\CacheBackendInterface $consistent_backend, Drupal\Core\Cache\CacheBackendInterface $fast_backend, $bin) Constructs a ChainedFastBackend object.
/**
* Constructs a ChainedFastBackend object.
*
* @param \Drupal\Core\Cache\CacheBackendInterface $consistent_backend
* The consistent cache backend.
* @param \Drupal\Core\Cache\CacheBackendInterface $fast_backend
* The fast cache backend.
* @param string $bin
* The cache bin for which the object is created.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:93
public get($cid, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:103
public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/ChainedFastBackend.php:112
protected time -> Drupal\Component\Datetime\Time#613 Depth Limit
public __construct(Drupal\Core\Database\Connection $connection, Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider, $bin, Drupal\Component\Serialization\ObjectAwareSerializationInterface $serializer, Drupal\Component\Datetime\TimeInterface $time, $max_rows = null) Constructs a DatabaseBackend object.
/**
* Constructs a DatabaseBackend object.
*
* @param \Drupal\Core\Database\Connection $connection
* The database connection.
* @param \Drupal\Core\Cache\CacheTagsChecksumInterface $checksum_provider
* The cache tags checksum provider.
* @param string $bin
* The cache bin for which the object is created.
* @param \Drupal\Component\Serialization\ObjectAwareSerializationInterface|int|string|null $serializer
* (optional) The serializer to use.
* @param \Drupal\Component\Datetime\TimeInterface|int|string|null $time
* The time service.
* @param int $max_rows
* (optional) The maximum number of rows that are allowed in this cache bin
* table.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:88
public get($cid, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:108
public getMultiple(&$cids, $allow_invalid = false) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:117
protected prepareItem($cache, $allow_invalid): mixed|false Prepares a cached item.
/**
* Prepares a cached item.
*
* Checks that items are either permanent or did not expire, and unserializes
* data as appropriate.
*
* @param object $cache
* An item loaded from self::get() or self::getMultiple().
* @param bool $allow_invalid
* If FALSE, the method returns FALSE if the cache item is not valid.
*
* @return mixed|false
* The item with data unserialized as appropriate and a property indicating
* whether the item is valid, or FALSE if there is no valid item to load.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:176
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:206
public setMultiple(array $items) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:219
protected doSetMultiple(array $items) Stores multiple items in the persistent cache.
/**
* Stores multiple items in the persistent cache.
*
* @param array $items
* An array of cache items, keyed by cid.
*
* @see \Drupal\Core\Cache\CacheBackendInterface::setMultiple()
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:247
public delete($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:315
public deleteMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:322
public deleteAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:345
public invalidate($cid) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:362
public invalidateMultiple(array $cids) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:369
public invalidateAll() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:389
public garbageCollection() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:404
public removeBin() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:437
protected ensureBinExists() Check if the cache bin exists and create it if not.
/**
* Check if the cache bin exists and create it if not.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:449
protected catchException(Exception $e, $table_name = null) Act on an exception when cache might be stale.
/**
* Act on an exception when cache might be stale.
*
* If the table does not yet exist, that's fine, but if the table exists and
* yet the query failed, then the cache is stale and the exception needs to
* propagate.
*
* @param \Exception $e
* The exception.
* @param string|null $table_name
* The table name. Defaults to $this->bin.
*
* @throws \Exception
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:481
protected normalizeCid($cid): string Normalizes a cache ID in order to comply with database limitations.
/**
* Normalizes a cache ID in order to comply with database limitations.
*
* @param string $cid
* The passed in cache ID.
*
* @return string
* An ASCII-encoded cache ID that is at most 255 characters long.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:496
public schemaDefinition() Defines the schema for the {cache_*} bin tables.
/**
* Defines the schema for the {cache_*} bin tables.
*
* @internal
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:519
public getMaxRows(): int Gets the maximum number of rows for this cache bin table.
/**
* Gets the maximum number of rows for this cache bin table.
*
* @return int
* The maximum number of rows that this cache bin table is allowed to store.
*/
Defined in <drupal>/core/lib/Drupal/Core/Cache/DatabaseBackend.php:587
public const Drupal\Core\Cache\DatabaseBackend::DEFAULT_MAX_ROWS :: integer 5000
public const Drupal\Core\Cache\DatabaseBackend::MAXIMUM_NONE :: integer -1
public const Drupal\Core\Cache\DatabaseBackend::MAX_ITEMS_PER_CACHE_SET :: integer 100
public const Drupal\Core\Cache\CacheBackendInterface::CACHE_PERMANENT :: integer -1
public __construct(string $app_root) InfoParser constructor.
/**
* InfoParser constructor.
*
* @param string $app_root
* The root directory of the Drupal installation.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/InfoParser.php:27
public parse($filename) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/InfoParser.php:44
protected getRequiredKeys(): array Returns an array of keys required to exist in .info.yml file.
/**
* Returns an array of keys required to exist in .info.yml file.
*
* @return array
* An array of required keys.
*/
Inherited from Drupal\Core\Extension\InfoParserDynamic
Defined in <drupal>/core/lib/Drupal/Core/Extension/InfoParserDynamic.php:107
public __construct(Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Lock\LockBackendInterface $lock) Constructs a State object.
/**
* Constructs a State object.
*
* @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory
* The key value store to use.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache
* The cache backend.
* @param \Drupal\Core\Lock\LockBackendInterface $lock
* The lock backend.
*/
Defined in <drupal>/core/lib/Drupal/Core/State/State.php:53
public get($key, $default = null) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/State/State.php:61
protected resolveCacheMiss($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/State/State.php:75
public getMultiple(array $keys) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/State/State.php:85
public set($key, $value) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/State/State.php:97
public setMultiple(array $data) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/State/State.php:119
public delete($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/State/State.php:131
public deleteMultiple(array $keys) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/State/State.php:139
public resetCache() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/State/State.php:149
public getValuesSetDuringRequest(string $key): ?array {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/State/State.php:156
protected registerKeySetDuringRequest(string $key, mixed $value, mixed $previousValue): void Registers a key that was set during the request.
/**
* Registers a key that was set during the request.
*
* @param string $key
* The key that was set.
* @param mixed $value
* The value that was set.
* @param mixed $previousValue
* The previous value that was stored.
*/
Defined in <drupal>/core/lib/Drupal/Core/State/State.php:170
protected getCid(): string Gets the cache ID.
/**
* Gets the cache ID.
*
* @return string
* The cache ID.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:127
public has($key) {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:134
protected persist($key, $persist = true) Flags an offset value to be written to the persistent cache.
/**
* Flags an offset value to be written to the persistent cache.
*
* @param string $key
* The key that was requested.
* @param bool $persist
* (optional) Whether the offset should be persisted or not, defaults to
* TRUE. When called with $persist = FALSE the offset will be un-flagged so
* that it will not be written at the end of the request.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:196
protected updateCache($lock = true) Writes a value to the persistent cache immediately.
/**
* Writes a value to the persistent cache immediately.
*
* @param bool $lock
* (optional) Whether to acquire a lock before writing to cache. Defaults to
* TRUE.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:222
public reset() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:289
public clear() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:299
public destruct() {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:312
protected lazyLoadCache() Loads the cache if not already done.
/**
* Loads the cache if not already done.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:319
protected invalidateCache() Invalidate the cache.
/**
* Invalidate the cache.
*/
Inherited from Drupal\Core\Cache\CacheCollector
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheCollector.php:335
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ProfileExtensionList.php:31
public __construct($root, $type, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Extension\InfoParserInterface $info_parser, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Drupal\Core\State\StateInterface $state, $install_profile) Constructs a new instance.
/**
* Constructs a new instance.
*
* @param string $root
* The app root.
* @param string $type
* The extension type.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache
* The cache.
* @param \Drupal\Core\Extension\InfoParserInterface $info_parser
* The info parser.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\State\StateInterface $state
* The state.
* @param string $install_profile
* The install profile used by the site.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:137
protected getExtensionDiscovery(): \Drupal\Core\Extension\ExtensionDiscovery Returns the extension discovery.
/**
* Returns the extension discovery.
*
* @return \Drupal\Core\Extension\ExtensionDiscovery
* The extension discovery.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:153
public reset(): $this Resets the stored extension list.
/**
* Resets the stored extension list.
*
* We don't reset statically added filenames, as it is a static cache which
* logically can't change. This is done for performance reasons of the
* installer.
*
* @return $this
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:166
protected getListCacheId(): string Returns the extension list cache ID.
/**
* Returns the extension list cache ID.
*
* @return string
* The list cache ID.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:193
protected getInfoCacheId(): string Returns the extension info cache ID.
/**
* Returns the extension info cache ID.
*
* @return string
* The info cache ID.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:203
protected getPathNamesCacheId(): string Returns the extension filenames cache ID.
/**
* Returns the extension filenames cache ID.
*
* @return string
* The filename cache ID.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:213
public exists($extension_name): bool Determines if an extension exists in the filesystem.
/**
* Determines if an extension exists in the filesystem.
*
* @param string $extension_name
* The machine name of the extension.
*
* @return bool
* TRUE if the extension exists (regardless installed or not) and FALSE if
* not.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:227
public getName($extension_name): string Returns the human-readable name of the extension.
/**
* Returns the human-readable name of the extension.
*
* @param string $extension_name
* The machine name of the extension.
*
* @return string
* The human-readable name of the extension.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:244
public get($extension_name): \Drupal\Core\Extension\Extension Returns a single extension.
/**
* Returns a single extension.
*
* @param string $extension_name
* The machine name of the extension.
*
* @return \Drupal\Core\Extension\Extension
* A processed extension object for the extension with the specified machine
* name.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:261
public getList(): \Drupal\Core\Extension\Extension[] Returns all available extensions.
/**
* Returns all available extensions.
*
* @return \Drupal\Core\Extension\Extension[]
* Processed extension objects, keyed by machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:276
protected doScanExtensions(): \Drupal\Core\Extension\Extension[] Scans the available extensions.
/**
* Scans the available extensions.
*
* Overriding this method gives other code the chance to add additional
* extensions to this raw listing.
*
* @return \Drupal\Core\Extension\Extension[]
* Unprocessed extension objects, keyed by machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:299
protected doList(): \Drupal\Core\Extension\Extension[] Builds the list of extensions.
/**
* Builds the list of extensions.
*
* @return \Drupal\Core\Extension\Extension[]
* Processed extension objects, keyed by machine name.
*
* @throws \Drupal\Core\Extension\InfoParserException
* If one of the .info.yml files is incomplete, or causes a parsing error.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:312
public getExtensionInfo($extension_name): mixed[] Returns information about a specified extension.
/**
* Returns information about a specified extension.
*
* This function returns the contents of the .info.yml file for the specified
* extension.
*
* @param string $extension_name
* The name of an extension whose information shall be returned.
*
* @return mixed[]
* An associative array of extension information.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:343
public getAllAvailableInfo(): array[] Returns an array of info files information of available extensions.
/**
* Returns an array of info files information of available extensions.
*
* This function returns the processed contents (with added defaults) of the
* .info.yml files.
*
* @return array[]
* An associative array of extension information arrays, keyed by extension
* name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:361
public getAllInstalledInfo(): array[] Returns an array of info files information of installed extensions.
/**
* Returns an array of info files information of installed extensions.
*
* This function returns the processed contents (with added defaults) of the
* .info.yml files.
*
* @return array[]
* An associative array of extension information arrays, keyed by extension
* name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:395
protected recalculateInfo(): array[] Generates the information from .info.yml files for extensions of this type.
/**
* Generates the information from .info.yml files for extensions of this type.
*
* @return array[]
* An array of arrays of .info.yml entries keyed by the machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:405
public getPathNames(): string[] Returns a list of extension file paths keyed by machine name.
/**
* Returns a list of extension file paths keyed by machine name.
*
* @return string[]
* An associative array of extension file paths, keyed by the extension
* machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:418
protected recalculatePathNames(): string[] Generates a sorted list of .info.yml file locations for all extensions.
/**
* Generates a sorted list of .info.yml file locations for all extensions.
*
* @return string[]
* An array of .info.yml file locations keyed by the extension machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:439
public setPathname($extension_name, $pathname) Sets the pathname for an extension.
/**
* Sets the pathname for an extension.
*
* This method is used in the Drupal bootstrapping phase, when the extension
* system is not fully initialized, to manually set locations of modules and
* profiles needed to complete bootstrapping.
*
* It is not recommended to call this method except in those rare cases.
*
* @param string $extension_name
* The machine name of the extension.
* @param string $pathname
* The pathname of the extension which is to be set explicitly rather
* than by consulting the dynamic extension listing.
*
* @internal
*
* @see ::getPathname
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:467
public getPathname($extension_name): string Gets the info file path for an extension.
/**
* Gets the info file path for an extension.
*
* The info path, whether provided, cached, or retrieved from the database, is
* only returned if the file exists.
*
* This function plays a key role in allowing Drupal's extensions (modules,
* themes, profiles, theme_engines, etc.) to be located in different places
* depending on a site's configuration. For example, a module 'foo' may
* legally be located in any of these four places:
*
* - core/modules/foo/foo.info.yml
* - modules/foo/foo.info.yml
* - sites/all/modules/foo/foo.info.yml
* - sites/example.com/modules/foo/foo.info.yml
*
* while a theme 'bar' may be located in any of the following four places:
*
* - core/themes/bar/bar.info.yml
* - themes/bar/bar.info.yml
* - sites/all/themes/bar/bar.info.yml
* - sites/example.com/themes/bar/bar.info.yml
*
* An installation profile maybe be located in any of the following places:
*
* - core/profiles/baz/baz.info.yml
* - profiles/baz/baz.info.yml
*
* Calling ExtensionList::getPathname('foo') will give you one of the above,
* depending on where the extension is located and what type it is.
*
* @param string $extension_name
* The machine name of the extension for which the pathname is requested.
*
* @return string
* The drupal-root relative filename and path of the requested extension's
* .info.yml file.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:512
public getPath($extension_name): string Gets the path to an extension of a specific type (module, theme, etc.).
/**
* Gets the path to an extension of a specific type (module, theme, etc.).
*
* The path is the directory in which the .info file is located. This name is
* coming from \SplFileInfo.
*
* @param string $extension_name
* The machine name of the extension for which the path is requested.
*
* @return string
* The Drupal-root-relative path to the specified extension.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:540
protected createExtensionInfo(Drupal\Core\Extension\Extension $extension): array Creates the info value for an extension object.
/**
* Creates the info value for an extension object.
*
* @param \Drupal\Core\Extension\Extension $extension
* The extension whose info is to be altered.
*
* @return array
* The extension info array.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:553
public checkIncompatibility($name): bool Tests the compatibility of an extension.
/**
* Tests the compatibility of an extension.
*
* @param string $name
* The extension name to check.
*
* @return bool
* TRUE if the extension is incompatible and FALSE if not.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:583
public static Drupal\Core\Extension\ExtensionList::sortByName(Drupal\Core\Extension\Extension $a, Drupal\Core\Extension\Extension $b): int Array sorting callback; sorts extensions by their name.
/**
* Array sorting callback; sorts extensions by their name.
*
* @param \Drupal\Core\Extension\Extension $a
* The first extension to compare.
* @param \Drupal\Core\Extension\Extension $b
* The second extension to compare.
*
* @return int
* Less than 0 if $a is less than $b, more than 0 if $a is greater than $b,
* and 0 if they are equal.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:600
protected stringTranslation -> null
public __construct($root, $type, Drupal\Core\Cache\CacheBackendInterface $cache, Drupal\Core\Extension\InfoParserInterface $info_parser, Drupal\Core\Extension\ModuleHandlerInterface $module_handler, Drupal\Core\State\StateInterface $state, Drupal\Core\Config\ConfigFactoryInterface $config_factory, Drupal\Core\Extension\ExtensionList $profile_list, $install_profile, array $container_modules_info = array()) Constructs a new ModuleExtensionList instance.
/**
* Constructs a new ModuleExtensionList instance.
*
* @param string $root
* The app root.
* @param string $type
* The extension type.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache
* The cache.
* @param \Drupal\Core\Extension\InfoParserInterface $info_parser
* The info parser.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\State\StateInterface $state
* The state.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory.
* @param \Drupal\Core\Extension\ExtensionList $profile_list
* The site profile listing.
* @param string $install_profile
* The install profile used by the site.
* @param array[] $container_modules_info
* (optional) The module locations coming from the compiled container.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:73
protected getExtensionDiscovery() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:88
protected getProfileDirectories(Drupal\Core\Extension\ExtensionDiscovery $discovery): string[] Finds all installation profile paths.
/**
* Finds all installation profile paths.
*
* @param \Drupal\Core\Extension\ExtensionDiscovery $discovery
* The extension discovery.
*
* @return string[]
* Paths to all installation profiles.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:107
protected getActiveProfile(): \Drupal\Core\Extension\Extension|null Gets the processed active profile object, or null.
/**
* Gets the processed active profile object, or null.
*
* @return \Drupal\Core\Extension\Extension|null
* The active profile, if there is one.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:125
protected doScanExtensions() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:137
protected doList() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:153
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:197
protected ensureRequiredDependencies(Drupal\Core\Extension\Extension $module, array $modules = array()) Marks dependencies of required modules as 'required', recursively.
/**
* Marks dependencies of required modules as 'required', recursively.
*
* @param \Drupal\Core\Extension\Extension $module
* The module extension object.
* @param \Drupal\Core\Extension\Extension[] $modules
* Extension objects for all available modules.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ModuleExtensionList.php:209
public reset(): $this Resets the stored extension list.
/**
* Resets the stored extension list.
*
* We don't reset statically added filenames, as it is a static cache which
* logically can't change. This is done for performance reasons of the
* installer.
*
* @return $this
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:166
protected getListCacheId(): string Returns the extension list cache ID.
/**
* Returns the extension list cache ID.
*
* @return string
* The list cache ID.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:193
protected getInfoCacheId(): string Returns the extension info cache ID.
/**
* Returns the extension info cache ID.
*
* @return string
* The info cache ID.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:203
protected getPathNamesCacheId(): string Returns the extension filenames cache ID.
/**
* Returns the extension filenames cache ID.
*
* @return string
* The filename cache ID.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:213
public exists($extension_name): bool Determines if an extension exists in the filesystem.
/**
* Determines if an extension exists in the filesystem.
*
* @param string $extension_name
* The machine name of the extension.
*
* @return bool
* TRUE if the extension exists (regardless installed or not) and FALSE if
* not.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:227
public getName($extension_name): string Returns the human-readable name of the extension.
/**
* Returns the human-readable name of the extension.
*
* @param string $extension_name
* The machine name of the extension.
*
* @return string
* The human-readable name of the extension.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:244
public get($extension_name): \Drupal\Core\Extension\Extension Returns a single extension.
/**
* Returns a single extension.
*
* @param string $extension_name
* The machine name of the extension.
*
* @return \Drupal\Core\Extension\Extension
* A processed extension object for the extension with the specified machine
* name.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:261
public getList(): \Drupal\Core\Extension\Extension[] Returns all available extensions.
/**
* Returns all available extensions.
*
* @return \Drupal\Core\Extension\Extension[]
* Processed extension objects, keyed by machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:276
public getExtensionInfo($extension_name): mixed[] Returns information about a specified extension.
/**
* Returns information about a specified extension.
*
* This function returns the contents of the .info.yml file for the specified
* extension.
*
* @param string $extension_name
* The name of an extension whose information shall be returned.
*
* @return mixed[]
* An associative array of extension information.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:343
public getAllAvailableInfo(): array[] Returns an array of info files information of available extensions.
/**
* Returns an array of info files information of available extensions.
*
* This function returns the processed contents (with added defaults) of the
* .info.yml files.
*
* @return array[]
* An associative array of extension information arrays, keyed by extension
* name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:361
public getAllInstalledInfo(): array[] Returns an array of info files information of installed extensions.
/**
* Returns an array of info files information of installed extensions.
*
* This function returns the processed contents (with added defaults) of the
* .info.yml files.
*
* @return array[]
* An associative array of extension information arrays, keyed by extension
* name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:395
protected recalculateInfo(): array[] Generates the information from .info.yml files for extensions of this type.
/**
* Generates the information from .info.yml files for extensions of this type.
*
* @return array[]
* An array of arrays of .info.yml entries keyed by the machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:405
public getPathNames(): string[] Returns a list of extension file paths keyed by machine name.
/**
* Returns a list of extension file paths keyed by machine name.
*
* @return string[]
* An associative array of extension file paths, keyed by the extension
* machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:418
protected recalculatePathNames(): string[] Generates a sorted list of .info.yml file locations for all extensions.
/**
* Generates a sorted list of .info.yml file locations for all extensions.
*
* @return string[]
* An array of .info.yml file locations keyed by the extension machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:439
public setPathname($extension_name, $pathname) Sets the pathname for an extension.
/**
* Sets the pathname for an extension.
*
* This method is used in the Drupal bootstrapping phase, when the extension
* system is not fully initialized, to manually set locations of modules and
* profiles needed to complete bootstrapping.
*
* It is not recommended to call this method except in those rare cases.
*
* @param string $extension_name
* The machine name of the extension.
* @param string $pathname
* The pathname of the extension which is to be set explicitly rather
* than by consulting the dynamic extension listing.
*
* @internal
*
* @see ::getPathname
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:467
public getPathname($extension_name): string Gets the info file path for an extension.
/**
* Gets the info file path for an extension.
*
* The info path, whether provided, cached, or retrieved from the database, is
* only returned if the file exists.
*
* This function plays a key role in allowing Drupal's extensions (modules,
* themes, profiles, theme_engines, etc.) to be located in different places
* depending on a site's configuration. For example, a module 'foo' may
* legally be located in any of these four places:
*
* - core/modules/foo/foo.info.yml
* - modules/foo/foo.info.yml
* - sites/all/modules/foo/foo.info.yml
* - sites/example.com/modules/foo/foo.info.yml
*
* while a theme 'bar' may be located in any of the following four places:
*
* - core/themes/bar/bar.info.yml
* - themes/bar/bar.info.yml
* - sites/all/themes/bar/bar.info.yml
* - sites/example.com/themes/bar/bar.info.yml
*
* An installation profile maybe be located in any of the following places:
*
* - core/profiles/baz/baz.info.yml
* - profiles/baz/baz.info.yml
*
* Calling ExtensionList::getPathname('foo') will give you one of the above,
* depending on where the extension is located and what type it is.
*
* @param string $extension_name
* The machine name of the extension for which the pathname is requested.
*
* @return string
* The drupal-root relative filename and path of the requested extension's
* .info.yml file.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied machine name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:512
public getPath($extension_name): string Gets the path to an extension of a specific type (module, theme, etc.).
/**
* Gets the path to an extension of a specific type (module, theme, etc.).
*
* The path is the directory in which the .info file is located. This name is
* coming from \SplFileInfo.
*
* @param string $extension_name
* The machine name of the extension for which the path is requested.
*
* @return string
* The Drupal-root-relative path to the specified extension.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:540
protected createExtensionInfo(Drupal\Core\Extension\Extension $extension): array Creates the info value for an extension object.
/**
* Creates the info value for an extension object.
*
* @param \Drupal\Core\Extension\Extension $extension
* The extension whose info is to be altered.
*
* @return array
* The extension info array.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:553
public checkIncompatibility($name): bool Tests the compatibility of an extension.
/**
* Tests the compatibility of an extension.
*
* @param string $name
* The extension name to check.
*
* @return bool
* TRUE if the extension is incompatible and FALSE if not.
*
* @throws \Drupal\Core\Extension\Exception\UnknownExtensionException
* If there is no extension with the supplied name.
*/
Inherited from Drupal\Core\Extension\ExtensionList
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:583
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public static Drupal\Core\Extension\ExtensionList::sortByName(Drupal\Core\Extension\Extension $a, Drupal\Core\Extension\Extension $b): int Array sorting callback; sorts extensions by their name.
/**
* Array sorting callback; sorts extensions by their name.
*
* @param \Drupal\Core\Extension\Extension $a
* The first extension to compare.
* @param \Drupal\Core\Extension\Extension $b
* The second extension to compare.
*
* @return int
* Less than 0 if $a is less than $b, more than 0 if $a is greater than $b,
* and 0 if they are equal.
*/
Defined in <drupal>/core/lib/Drupal/Core/Extension/ExtensionList.php:600
/**
* @param string|null $vendorDir
*/
Defined in <vendor>/composer/ClassLoader.php:106
public getPrefixes(): array<string, list<string>>
/**
* @return array<string, list<string>>
*/
Defined in <vendor>/composer/ClassLoader.php:115
public getPrefixesPsr4(): array<string, list<string>>
/**
* @return array<string, list<string>>
*/
Defined in <vendor>/composer/ClassLoader.php:127
public getFallbackDirs(): list<string>
/**
* @return list<string>
*/
Defined in <vendor>/composer/ClassLoader.php:135
public getFallbackDirsPsr4(): list<string>
/**
* @return list<string>
*/
Defined in <vendor>/composer/ClassLoader.php:143
public getClassMap(): array<string, string> Array of classname => path
/**
* @return array<string, string> Array of classname => path
*/
Defined in <vendor>/composer/ClassLoader.php:151
public addClassMap(array $classMap): void
/**
* @param array<string, string> $classMap Class to filename map
*
* @return void
*/
Defined in <vendor>/composer/ClassLoader.php:161
public add($prefix, $paths, $prepend = false): void Registers a set of PSR-0 directories for a given prefix, either appending or ...
/**
* Registers a set of PSR-0 directories for a given prefix, either
* appending or prepending to the ones previously set for this prefix.
*
* @param string $prefix The prefix
* @param list<string>|string $paths The PSR-0 root directories
* @param bool $prepend Whether to prepend the directories
*
* @return void
*/
Defined in <vendor>/composer/ClassLoader.php:180
public addPsr4($prefix, $paths, $prepend = false): void Registers a set of PSR-4 directories for a given namespace, either appending ...
/**
* Registers a set of PSR-4 directories for a given namespace, either
* appending or prepending to the ones previously set for this namespace.
*
* @param string $prefix The prefix/namespace, with trailing '\\'
* @param list<string>|string $paths The PSR-4 base directories
* @param bool $prepend Whether to prepend the directories
*
* @throws \InvalidArgumentException
*
* @return void
*/
Defined in <vendor>/composer/ClassLoader.php:230
public set($prefix, $paths): void Registers a set of PSR-0 directories for a given prefix, replacing any others...
/**
* Registers a set of PSR-0 directories for a given prefix,
* replacing any others previously set for this prefix.
*
* @param string $prefix The prefix
* @param list<string>|string $paths The PSR-0 base directories
*
* @return void
*/
Defined in <vendor>/composer/ClassLoader.php:278
public setPsr4($prefix, $paths): void Registers a set of PSR-4 directories for a given namespace, replacing any oth...
/**
* Registers a set of PSR-4 directories for a given namespace,
* replacing any others previously set for this namespace.
*
* @param string $prefix The prefix/namespace, with trailing '\\'
* @param list<string>|string $paths The PSR-4 base directories
*
* @throws \InvalidArgumentException
*
* @return void
*/
Defined in <vendor>/composer/ClassLoader.php:298
public setUseIncludePath($useIncludePath): void Turns on searching the include path for class files.
/**
* Turns on searching the include path for class files.
*
* @param bool $useIncludePath
*
* @return void
*/
Defined in <vendor>/composer/ClassLoader.php:319
public getUseIncludePath(): bool Can be used to check if the autoloader uses the include path to check for cla...
/**
* Can be used to check if the autoloader uses the include path to check
* for classes.
*
* @return bool
*/
Defined in <vendor>/composer/ClassLoader.php:330
public setClassMapAuthoritative($classMapAuthoritative): void Turns off searching the prefix and fallback directories for classes that have...
/**
* Turns off searching the prefix and fallback directories for classes
* that have not been registered with the class map.
*
* @param bool $classMapAuthoritative
*
* @return void
*/
Defined in <vendor>/composer/ClassLoader.php:343
public isClassMapAuthoritative(): bool Should class lookup fail if not found in the current class map?
/**
* Should class lookup fail if not found in the current class map?
*
* @return bool
*/
Defined in <vendor>/composer/ClassLoader.php:353
public setApcuPrefix($apcuPrefix): void APCu prefix to use to cache found/not-found classes, if the extension is enab...
/**
* APCu prefix to use to cache found/not-found classes, if the extension is enabled.
*
* @param string|null $apcuPrefix
*
* @return void
*/
Defined in <vendor>/composer/ClassLoader.php:365
public getApcuPrefix(): string|null The APCu prefix in use, or null if APCu caching is not enabled.
/**
* The APCu prefix in use, or null if APCu caching is not enabled.
*
* @return string|null
*/
Defined in <vendor>/composer/ClassLoader.php:375
public register($prepend = false): void Registers this instance as an autoloader.
/**
* Registers this instance as an autoloader.
*
* @param bool $prepend Whether to prepend the autoloader or not
*
* @return void
*/
Defined in <vendor>/composer/ClassLoader.php:387
public unregister(): void Unregisters this instance as an autoloader.
/**
* Unregisters this instance as an autoloader.
*
* @return void
*/
Defined in <vendor>/composer/ClassLoader.php:408
public loadClass($class): true|null True if loaded, null otherwise Loads the given class or interface.
/**
* Loads the given class or interface.
*
* @param string $class The name of the class
* @return true|null True if loaded, null otherwise
*/
Defined in <vendor>/composer/ClassLoader.php:423
public findFile($class): string|false The path if found, false otherwise Finds the path to the file where the class is defined.
/**
* Finds the path to the file where the class is defined.
*
* @param string $class The name of the class
*
* @return string|false The path if found, false otherwise
*/
Defined in <vendor>/composer/ClassLoader.php:442
/**
* @param string $class
* @param string $ext
* @return string|false
*/
Defined in <vendor>/composer/ClassLoader.php:492
public static Composer\Autoload\ClassLoader::getRegisteredLoaders(): array<string, self> Returns the currently registered loaders keyed by their corresponding vendor ...
/**
* Returns the currently registered loaders keyed by their corresponding vendor directories.
*
* @return array<string, self>
*/
Defined in <vendor>/composer/ClassLoader.php:482
public __construct($environment, $class_loader, $allow_dumping = true, $app_root = null) Constructs a DrupalKernel object.
/**
* Constructs a DrupalKernel object.
*
* @param string $environment
* String indicating the environment, e.g. 'prod' or 'dev'.
* @param \Composer\Autoload\ClassLoader $class_loader
* The class loader. Normally \Composer\Autoload\ClassLoader, as included by
* the front controller, but may also be decorated.
* @param bool $allow_dumping
* (optional) FALSE to stop the container from being written to or read
* from disk. Defaults to TRUE.
* @param string $app_root
* (optional) The path to the application root as a string. If not supplied,
* the application root will be computed.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:329
public setSitePath($path) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:471
public getSitePath() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:481
public getAppRoot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:488
public boot() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:495
public shutdown() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:549
public getContainer() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:566
public getCachedContainerDefinition() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:573
public loadLegacyIncludes() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:586
public preHandle(Symfony\Component\HttpFoundation\Request $request) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:597
public discoverServiceProviders() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:636
public getServiceProviders($origin) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:707
public terminate(Symfony\Component\HttpFoundation\Request $request, Symfony\Component\HttpFoundation\Response $response): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:714
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:736
protected handleException(Exception $e, $request, $type): \Symfony\Component\HttpFoundation\Response Converts an exception into a response.
/**
* Converts an exception into a response.
*
* @param \Exception $e
* An exception.
* @param \Symfony\Component\HttpFoundation\Request $request
* A Request instance.
* @param int $type
* The type of the request (one of HttpKernelInterface::MAIN_REQUEST or
* HttpKernelInterface::SUB_REQUEST)
*
* @return \Symfony\Component\HttpFoundation\Response
* A Response instance
*
* @throws \Exception
* If the passed in exception cannot be turned into a response.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:784
protected moduleData($module): \Drupal\Core\Extension\Extension|false Returns module data on the filesystem.
/**
* Returns module data on the filesystem.
*
* @param string $module
* The name of the module.
*
* @return \Drupal\Core\Extension\Extension|false
* Returns an Extension object if the module is found, FALSE otherwise.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:808
private setExtensionData(): void Sets extension data to class properties using ExtensionDiscovery.
/**
* Sets extension data to class properties using ExtensionDiscovery.
*
* This function is expensive to call as it scans the filesystem for
* extensions. Use ::moduleData() and ::themeExtensions() instead.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:821
public updateModules(array $module_list, array $module_filenames = array()) Implements Drupal\Core\DrupalKernelInterface::updateModules().
/**
* Implements Drupal\Core\DrupalKernelInterface::updateModules().
*
* @todo Remove obsolete $module_list parameter. Only $module_filenames is
* needed.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:846
protected themeExtensions($theme): Drupal\Core\Extension\Extension|false Returns theme data on the filesystem.
/**
* Returns theme data on the filesystem.
*
* This allows us to update the container parameters and namespaces during
* compile, theme install and theme uninstall. This ensures that the
* container remains in sync before compiler passes.
*
* @param string $theme
* The name of the theme.
*
* @return \Drupal\Core\Extension\Extension|false
* Returns an Extension object if the theme is found, FALSE otherwise.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:896
public updateThemes(array $register_themes = array()): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:906
protected getContainerCacheKey(): string Returns the container cache key based on the environment.
/**
* Returns the container cache key based on the environment.
*
* The 'environment' consists of:
* - The kernel environment string.
* - A hash based on all the installed package versions.
* - The deployment identifier from settings.php. This allows custom
* deployments to force a container rebuild.
* - The operating system running PHP. This allows compiler passes to optimize
* services for different operating systems.
* - The paths to any additional container YAMLs from settings.php.
*
* @return string
* The cache key used for the service container.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:960
protected getKernelParameters(): array Returns the kernel parameters.
/**
* Returns the kernel parameters.
*
* @return array
* An associative array of kernel parameters
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:978
protected initializeContainer(): \Symfony\Component\DependencyInjection\ContainerInterface Initializes the service container.
/**
* Initializes the service container.
*
* @return \Symfony\Component\DependencyInjection\ContainerInterface
* An initialized container object.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:990
protected initializeSettings(Symfony\Component\HttpFoundation\Request $request) Locate site path and initialize settings singleton.
/**
* Locate site path and initialize settings singleton.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The current request.
*
* @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
* In case the host name in the request is not trusted.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1198
protected initializeRequestGlobals(Symfony\Component\HttpFoundation\Request $request) Bootstraps the legacy global request variables.
/**
* Bootstraps the legacy global request variables.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The current request.
*
* @todo D8: Eliminate this entirely in favor of Request object.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1221
protected getServicesToPersist(Symfony\Component\DependencyInjection\ContainerInterface $container) Returns service instances to persist from an old container to a new one.
/**
* Returns service instances to persist from an old container to a new one.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1256
protected persistServices(Symfony\Component\DependencyInjection\ContainerInterface $container, array $persist) Moves persistent service instances into a new container.
/**
* Moves persistent service instances into a new container.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1270
public rebuildContainer() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1283
public resetContainer(): Symfony\Component\DependencyInjection\ContainerInterface {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1300
public invalidateContainer() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1393
protected attachSynthetic(Symfony\Component\DependencyInjection\ContainerInterface $container): \Symfony\Component\DependencyInjection\ContainerInterface Attach synthetic values on to kernel.
/**
* Attach synthetic values on to kernel.
*
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
* Container object.
*
* @return \Symfony\Component\DependencyInjection\ContainerInterface
* The container object with the kernel and the class loader added.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1417
protected compileContainer(): \Drupal\Core\DependencyInjection\ContainerBuilder Compiles a new service container.
/**
* Compiles a new service container.
*
* @return \Drupal\Core\DependencyInjection\ContainerBuilder
* The compiled service container
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1441
protected initializeServiceProviders() Registers all service providers to the kernel.
/**
* Registers all service providers to the kernel.
*
* @throws \LogicException
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1552
protected getContainerBuilder(): \Drupal\Core\DependencyInjection\ContainerBuilder Gets a new ContainerBuilder instance used to build the service container.
/**
* Gets a new ContainerBuilder instance used to build the service container.
*
* @return \Drupal\Core\DependencyInjection\ContainerBuilder
* The Drupal dependency injection container builder.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1576
protected cacheDrupalContainer(array $container_definition): bool Stores the container definition in a cache.
/**
* Stores the container definition in a cache.
*
* @param array $container_definition
* The container definition to cache.
*
* @return bool
* TRUE if the container was successfully cached.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1589
protected getHttpKernel(): \Symfony\Component\HttpKernel\HttpKernelInterface Gets a http kernel from the container.
/**
* Gets a http kernel from the container.
*
* @return \Symfony\Component\HttpKernel\HttpKernelInterface
* The Symfony HTTP kernel service.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1610
protected getConfigStorage(): \Drupal\Core\Config\StorageInterface Gets the active configuration storage to use during building the container.
/**
* Gets the active configuration storage to use during building the container.
*
* @return \Drupal\Core\Config\StorageInterface
* The configuration storage.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1620
protected getModulesParameter(): array Returns an array of Extension class parameters for all enabled modules.
/**
* Returns an array of Extension class parameters for all enabled modules.
*
* @return array
* An associated array of module class parameters, keyed by module name, for
* all enabled modules.
*
* @deprecated in drupal:11.3.0 and is removed from drupal:12.0.0. Use
* getExtensionsParameter() instead.
*
* @see https://www.drupal.org/node/3551652
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1646
protected getExtensionsParameter(array $extension_list, callable $get_data): array Returns an array of Extension class parameters for all enabled extensions.
/**
* Returns an array of Extension class parameters for all enabled extensions.
*
* @param array $extension_list
* The list of extensions to return filenames for.
* @param callable $get_data
* The method to get data for the extension type.
*
* @return array
* An associated array of extension class parameters, keyed by extension
* name, for all enabled themes.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1663
protected getModuleFileNames(): array Gets the filenames for each enabled module.
/**
* Gets the filenames for each enabled module.
*
* @return array
* Array where each key is a module name, and each value is a path to the
* respective *.info.yml file.
*
* @deprecated in drupal:11.3.0 and is removed from drupal:12.0.0. Use
* getExtensionFileNames() instead.
*
* @see https://www.drupal.org/node/3551652
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1689
protected getExtensionFileNames(array $extension_list, callable $get_data): array Gets the filenames for each enabled extension.
/**
* Gets the filenames for each enabled extension.
*
* @param array $extension_list
* The list of extensions to return filenames for.
* @param callable $get_data
* The method to get data for the extension type.
*
* @return array
* Array where each key is a theme name, and each value is a path to the
* respective *.info.yml file.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1706
protected getModuleNamespacesPsr4($module_file_names): string[] Gets the PSR-4 base directories for module namespaces.
/**
* Gets the PSR-4 base directories for module namespaces.
*
* @param string[] $module_file_names
* Array where each key is a module name, and each value is a path to
* the respective *.info.yml file.
*
* @return string[]
* Array where each key is a module namespace like 'Drupal\system', and
* each value is the PSR-4 base directory associated with the module
* namespace.
*
* @deprecated in drupal:11.3.0 and is removed from drupal:12.0.0. Use
* getExtensionNamespacesPsr4() instead.
*
* @see https://www.drupal.org/node/3551652
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1733
protected getExtensionNamespacesPsr4(array $extension_file_names): array Gets the PSR-4 base directories for extension namespaces.
/**
* Gets the PSR-4 base directories for extension namespaces.
*
* @param string[] $extension_file_names
* Array where each key is an extension name, and each value is a path to
* the respective *.info.yml file.
*
* @return string[]
* Array where each key is an extension namespace like 'Drupal\system', and
* each value is the PSR-4 base directory associated with the extension
* namespace.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1750
protected classLoaderAddMultiplePsr4(array $namespaces = array(), $class_loader = null) Registers a list of namespaces with PSR-4 directories for class loading.
/**
* Registers a list of namespaces with PSR-4 directories for class loading.
*
* @param array $namespaces
* Array where each key is a namespace like 'Drupal\system', and each value
* is either a PSR-4 base directory, or an array of PSR-4 base directories
* associated with this namespace.
* @param object $class_loader
* The class loader. Normally \Composer\Autoload\ClassLoader, as included by
* the front controller, but may also be decorated.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1769
protected addServiceFiles(array $service_yamls) Add service files.
/**
* Add service files.
*
* @param string[] $service_yamls
* A list of service files.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1891
protected getInstallProfile(): string|false|null Gets the active install profile.
/**
* Gets the active install profile.
*
* @return string|false|null
* The name of the active install profile or distribution, FALSE if there is
* no install profile or NULL if Drupal is being installed.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1902
protected initializeEphemeralSession(Symfony\Component\HttpFoundation\Request $request): void Initializes a session backed by in-memory store and puts it on the request.
/**
* Initializes a session backed by in-memory store and puts it on the request.
*
* A simple in-memory store is sufficient for command line tools and tests.
* Web requests will be processed by the session middleware where the mock
* session is replaced by a session object backed with persistent storage and
* a real session handler.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request.
*
* @see \Drupal\Core\StackMiddleware\Session::handle()
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1923
protected getExtensions(): array|false Get the core.extension config object.
/**
* Get the core.extension config object.
*
* @return array|false
* The core.extension config object if it exists or FALSE.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1935
protected isCli(): bool Returns whether the current PHP process runs on CLI.
/**
* Returns whether the current PHP process runs on CLI.
*
* @return bool
* TRUE if the current PHP process is running on CLI, otherwise FALSE.
*/
Defined in <drupal>/core/lib/Drupal/Core/Installer/InstallerRedirectTrait.php:23
protected shouldRedirectToInstaller(Throwable $exception, ?Drupal\Core\Database\Connection $connection = null): bool Determines if an exception handler should redirect to the installer.
/**
* Determines if an exception handler should redirect to the installer.
*
* @param \Throwable $exception
* The exception to check.
* @param \Drupal\Core\Database\Connection|null $connection
* (optional) The default database connection. If not provided, a less
* comprehensive check will be performed. This can be the case if the
* exception occurs early enough that a database connection object isn't
* available from the container yet.
*
* @return bool
* TRUE if the exception handler should redirect to the installer because
* Drupal is not installed yet, or FALSE otherwise.
*/
Defined in <drupal>/core/lib/Drupal/Core/Installer/InstallerRedirectTrait.php:42
public static Drupal\Core\DrupalKernel::createFromRequest(Symfony\Component\HttpFoundation\Request $request, $class_loader, $environment, $allow_dumping = true, $app_root = null): static Create a DrupalKernel object from a request.
/**
* Create a DrupalKernel object from a request.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request.
* @param \Composer\Autoload\ClassLoader $class_loader
* The class loader. Normally Composer's ClassLoader, as included by the
* front controller, but may also be decorated.
* @param string $environment
* String indicating the environment, e.g. 'prod' or 'dev'.
* @param bool $allow_dumping
* (optional) FALSE to stop the container from being written to or read
* from disk. Defaults to TRUE.
* @param string $app_root
* (optional) The path to the application root as a string. If not supplied,
* the application root will be computed.
*
* @return static
*
* @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
* In case the host name in the request is not trusted.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:307
protected static Drupal\Core\DrupalKernel::guessApplicationRoot(): string Determine the application root directory based on this file's location.
/**
* Determine the application root directory based on this file's location.
*
* @return string
* The application root.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:345
public static Drupal\Core\DrupalKernel::findSitePath(Symfony\Component\HttpFoundation\Request $request, $require_settings = true, $app_root = null): string Returns the appropriate site directory for a request.
/**
* Returns the appropriate site directory for a request.
*
* Once the kernel has been created DrupalKernelInterface::getSitePath() is
* preferred since it gets the statically cached result of this method.
*
* Site directories contain all site specific code. This includes settings.php
* for bootstrap level configuration, file configuration stores, public file
* storage and site specific modules and themes.
*
* A file named sites.php must be present in the sites directory for
* multisite. If it doesn't exist, then 'sites/default' will be used.
*
* Finds a matching site directory file by stripping the website's hostname
* from left to right and pathname from right to left. By default, the
* directory must contain a 'settings.php' file for it to match. If the
* parameter $require_settings is set to FALSE, then a directory without a
* 'settings.php' file will match as well. The first configuration file found
* will be used and the remaining ones will be ignored. If no configuration
* file is found, returns a default value 'sites/default'. See
* default.settings.php for examples on how the URL is converted to a
* directory.
*
* The sites.php file in the sites directory can define aliases in an
* associative array named $sites. The array is written in the format
* '<port>.<domain>.<path>' => 'directory'. As an example, to create a
* directory alias for https://www.drupal.org:8080/my-site/test whose
* configuration file is in sites/example.com, the array should be defined as:
* @code
* $sites = [
* '8080.www.drupal.org.my-site.test' => 'example.com',
* ];
* @endcode
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The current request.
* @param bool $require_settings
* Only directories with an existing settings.php file will be recognized.
* Defaults to TRUE. During initial installation, this is set to FALSE so
* that Drupal can detect a matching directory, then create a new
* settings.php file in it.
* @param string $app_root
* (optional) The path to the application root as a string. If not supplied,
* the application root will be computed.
*
* @return string
* The path of the matching directory.
*
* @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
* In case the host name in the request is invalid.
*
* @see \Drupal\Core\DrupalKernelInterface::getSitePath()
* @see \Drupal\Core\DrupalKernelInterface::setSitePath()
* @see default.settings.php
* @see example.sites.php
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:409
public static Drupal\Core\DrupalKernel::bootEnvironment($app_root = null) Setup a consistent PHP environment.
/**
* Setup a consistent PHP environment.
*
* This method sets PHP environment options we want to be sure are set
* correctly for security or just saneness.
*
* @param string $app_root
* (optional) The path to the application root as a string. If not supplied,
* the application root will be computed.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1118
protected static Drupal\Core\DrupalKernel::validateHostnameLength($host): bool Validates a hostname length.
/**
* Validates a hostname length.
*
* @param string $host
* A hostname.
*
* @return bool
* TRUE if the length is appropriate, or FALSE otherwise.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1795
public static Drupal\Core\DrupalKernel::validateHostname(Symfony\Component\HttpFoundation\Request $request): bool Validates the hostname supplied from the HTTP request.
/**
* Validates the hostname supplied from the HTTP request.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request object.
*
* @return bool
* TRUE if the hostname is valid, or FALSE otherwise.
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1814
protected static Drupal\Core\DrupalKernel::setupTrustedHosts(Symfony\Component\HttpFoundation\Request $request, $host_patterns): bool Sets up the lists of trusted HTTP Host headers.
/**
* Sets up the lists of trusted HTTP Host headers.
*
* Since the HTTP Host header can be set by the user making the request, it
* is possible to create an attack vectors against a site by overriding this.
* Symfony provides a mechanism for creating a list of trusted Host values.
*
* Host patterns (as regular expressions) can be configured through
* settings.php for multisite installations, sites using ServerAlias without
* canonical redirection, or configurations where the site responds to default
* requests. For example,
*
* @code
* $settings['trusted_host_patterns'] = [
* '^example\.com$',
* '^*.example\.com$',
* ];
* @endcode
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request object.
* @param array $host_patterns
* The array of trusted host patterns.
*
* @return bool
* TRUE if the Host header is trusted, FALSE otherwise.
*
* @see https://www.drupal.org/docs/installing-drupal/trusted-host-settings
* @see \Drupal\Core\Http\TrustedHostsRequestFactory
*/
Defined in <drupal>/core/lib/Drupal/Core/DrupalKernel.php:1861
/**
* Constructs a \Drupal\Core\Theme\Registry object.
*
* @param string $root
* The app root.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache
* The cache backend interface to use for the complete theme registry data.
* @param \Drupal\Core\Lock\LockBackendInterface $lock
* The lock backend.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler to use to load modules.
* @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
* The theme handler.
* @param \Drupal\Core\Theme\ThemeInitializationInterface $theme_initialization
* The theme initialization.
* @param \Drupal\Core\Cache\CacheBackendInterface $runtime_cache
* The cache backend interface to use for the runtime theme registry data.
* @param \Drupal\Core\Extension\ModuleExtensionList $module_list
* The module list.
* @param \Symfony\Component\HttpKernel\HttpKernelInterface $kernel
* The kernel.
* @param string $theme_name
* (optional) The name of the theme for which to construct the registry.
* @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface|null $key_value_factory
* The key value factory.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:233
public setThemeManager(Drupal\Core\Theme\ThemeManagerInterface $theme_manager) Sets the theme manager.
/**
* Sets the theme manager.
*
* @param \Drupal\Core\Theme\ThemeManagerInterface $theme_manager
* The theme manager.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:256
protected init($theme_name = null) Initializes a theme with a certain name.
/**
* Initializes a theme with a certain name.
*
* This function does to much magic, so it should be replaced by another
* services which holds the current active theme information.
*
* @param string $theme_name
* (optional) The name of the theme for which to construct the registry.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:269
public get(): array Returns the complete theme registry from cache or rebuilds it.
/**
* Returns the complete theme registry from cache or rebuilds it.
*
* @return array
* The complete theme registry data array.
*
* @see Registry::$registry
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:292
protected cacheGet(): ?array Gets the theme registry cache.
/**
* Gets the theme registry cache.
*
* @return array|null
* The complete theme registry data array for the active theme for this
* registry.
*
* @see Registry::$registry
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:345
public getRuntime(): \Drupal\Core\Utility\ThemeRegistry Returns the incomplete, runtime theme registry.
/**
* Returns the incomplete, runtime theme registry.
*
* @return \Drupal\Core\Utility\ThemeRegistry
* A shared instance of the ThemeRegistry class, provides an ArrayObject
* that allows it to be accessed with array syntax and isset(), and is more
* lightweight than the full registry.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:365
protected setCache() Persists the theme registry in the cache backend.
/**
* Persists the theme registry in the cache backend.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:376
public getBaseHook($hook): string|false Returns the base hook for a given hook suggestion.
/**
* Returns the base hook for a given hook suggestion.
*
* @param string $hook
* The name of a theme hook whose base hook to find.
*
* @return string|false
* The name of the base hook or FALSE.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:389
protected build(): array Builds the theme registry cache.
/**
* Builds the theme registry cache.
*
* Theme hook definitions are collected in the following order:
* - Modules
* - Base theme engines
* - Base themes
* - Theme engine
* - Theme
*
* All theme hook definitions are essentially just collated and merged in the
* above order. However, various extension-specific default values and
* customizations are required; e.g., to record the effective file path for
* theme template. Therefore, this method first collects all extensions per
* type, and then dispatches the processing for each extension to
* processExtension().
*
* After completing the collection, modules are allowed to alter it. Lastly,
* any derived and incomplete theme hook definitions that are hook suggestions
* for base hooks (e.g., 'block__node' for the base hook 'block') need to be
* determined based on the full registry and classified as 'base hook'.
*
* See the @link themeable Default theme implementations topic @endlink for
* details.
*
* @return array
* The built theme registry.
*
* @see hook_theme_registry_alter()
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:438
protected processExtension(array &$cache, $name, $type, $theme, $path) Process a single implementation of hook_theme().
/**
* Process a single implementation of hook_theme().
*
* @param array $cache
* The theme registry that will eventually be cached; It is an associative
* array keyed by theme hooks, whose values are associative arrays
* describing the hook:
* - 'type': The passed-in $type.
* - 'theme path': The passed-in $path.
* - 'template': The filename of the template generating output for this
* theme hook. The template is in the directory defined by the 'path' key
* of hook_theme() or defaults to "$path/templates".
* - 'variables': The variables for this theme hook as defined in
* hook_theme(). If there is more than one implementation and 'variables'
* is not specified in a later one, then the previous definition is kept.
* - 'render element': The renderable element for this theme hook as defined
* in hook_theme(). If there is more than one implementation and
* 'render element' is not specified in a later one, then the previous
* definition is kept.
* - See the @link themeable Theme system overview topic @endlink for
* detailed documentation.
* @param string $name
* The name of the module, theme engine, base theme engine, theme or base
* theme implementing hook_theme().
* @param string $type
* One of 'module', 'theme_engine', 'base_theme_engine', 'theme',
* 'base_theme', or 'install'. Unlike regular hooks that can only be
* implemented by modules, each of these can implement hook_theme(). This
* function is called in aforementioned order and new entries override
* older ones. For example, if a theme hook is both defined by a module and
* a theme, then the definition in the theme will be used.
* @param string $theme
* The actual name of theme, module, etc. that is being processed.
* @param string $path
* The directory where $name is. For example, modules/system or
* themes/olivero.
*
* @see \Drupal\Core\Theme\ThemeManagerInterface::render()
* @see hook_theme()
* @see \Drupal\Core\Extension\ThemeHandler::listInfo()
* @see twig_render_template()
*
* @throws \BadFunctionCallException
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:550
protected completeSuggestion($hook, array &$cache) Completes the definition of the requested suggestion hook.
/**
* Completes the definition of the requested suggestion hook.
*
* @param string $hook
* The name of the suggestion hook to complete.
* @param array $cache
* The theme registry, as documented in
* \Drupal\Core\Theme\Registry::processExtension().
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:751
protected mergePreprocessFunctions($destination_hook_name, $source_hook_name, $parent_hook, array &$cache) Merges the source hook's preprocess functions into the destination hook's.
/**
* Merges the source hook's preprocess functions into the destination hook's.
*
* @param string $destination_hook_name
* The name of the hook to merge preprocess functions to.
* @param string $source_hook_name
* The name of the hook to merge preprocess functions from.
* @param array $parent_hook
* The parent hook if it exists. Either an incomplete hook from suggestions
* or a base hook.
* @param array $cache
* The theme registry, as documented in
* \Drupal\Core\Theme\Registry::processExtension().
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:791
protected postProcessExtension(array &$cache, Drupal\Core\Theme\ActiveTheme $theme) Completes the theme registry adding discovered functions and hooks.
/**
* Completes the theme registry adding discovered functions and hooks.
*
* @param array $cache
* The theme registry as documented in
* \Drupal\Core\Theme\Registry::processExtension().
* @param \Drupal\Core\Theme\ActiveTheme $theme
* Current active theme.
*
* @see ::processExtension()
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:819
public reset() Invalidates theme registry caches.
/**
* Invalidates theme registry caches.
*
* To be called when the list of enabled extensions is changed.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:925
public destruct() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:955
public getPrefixGroupedUserFunctions($prefixes = array()): array Gets all user functions grouped by the word before the first underscore.
/**
* Gets all user functions grouped by the word before the first underscore.
*
* @param string[] $prefixes
* An array of function prefixes by which the list can be limited.
*
* @return array
* Functions grouped by the first prefix.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:970
protected collectModulePreprocess(array &$cache, string $hook): array Collect module implementations of a single hook.
/**
* Collect module implementations of a single hook.
*
* @param array $cache
* The preprocess hook.
* @param string $hook
* The theme registry, as documented in
* \Drupal\Core\Theme\Registry::processExtension().
*
* @return array
* A list of preprocess functions.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:1005
protected hasThemeHookImplementation(string $theme, string $hook): bool Returns whether a theme implements a given hook.
/**
* Returns whether a theme implements a given hook.
*
* @param string $theme
* Name of the theme.
* @param string $hook
* Name of the hook.
*
* @return bool
* True if the theme implements the given hook.
*/
Defined in <drupal>/core/lib/Drupal/Core/Theme/Registry.php:1031
public __construct(Drupal\Core\Entity\EntityTypeInterface $entity_type, Drupal\Core\Entity\EntityRepositoryInterface $entity_repository, Drupal\Core\Language\LanguageManagerInterface $language_manager, Drupal\Core\Theme\Registry $theme_registry, Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository) Constructs a new EntityViewBuilder.
new \Drupal\Core\Entity\EntityViewBuilder()
/**
* Constructs a new EntityViewBuilder.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
* The entity repository service.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
* @param \Drupal\Core\Theme\Registry $theme_registry
* The theme registry.
* @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
* The entity display repository.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:97
public view(Drupal\Core\Entity\EntityInterface $entity, $view_mode = 'full', $langcode = null) {@inheritdoc}
$0['#pre_render'][0][0]->view()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:122
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:145
protected getBuildDefaults(Drupal\Core\Entity\EntityInterface $entity, $view_mode): array Provides entity-specific defaults to the build process.
/**
* Provides entity-specific defaults to the build process.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity for which the defaults should be provided.
* @param string $view_mode
* The view mode that should be used.
*
* @return array
* A build array with entity specific defaults added.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:178
public build(array $build): array Builds an entity's view; augments entity defaults.
$0['#pre_render'][0][0]->build()
/**
* Builds an entity's view; augments entity defaults.
*
* This function is assigned as a #pre_render callback in ::view().
*
* It transforms the renderable array for a single entity to the same
* structure as if we were rendering multiple entities, and then calls the
* default ::buildMultiple() #pre_render callback.
*
* @param array $build
* A renderable array containing build information and context for an entity
* view.
*
* @return array
* The updated renderable array.
*
* @see \Drupal\Core\Render\RendererInterface::render()
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:238
/**
* Builds multiple entities' views; augments entity defaults.
*
* This function is assigned as a #pre_render callback in ::viewMultiple().
*
* By delaying the building of an entity until the #pre_render processing in
* \Drupal::service('renderer')->render(), the processing cost of assembling
* an entity's renderable array is saved on cache-hit requests.
*
* @param array $build_list
* A renderable array containing build information and context for an
* entity view.
*
* @return array
* The updated renderable array.
*
* @see \Drupal\Core\Render\RendererInterface::render()
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:262
public buildComponents(array &$build, array $entities, array $displays, $view_mode) {@inheritdoc}
$0['#pre_render'][0][0]->buildComponents()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:316
/**
* Add contextual links.
*
* @param array $build
* The render array that is being created.
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity to be prepared.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:356
/**
* Specific per-entity building.
*
* @param array $build
* The render array that is being created.
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity to be prepared.
* @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display
* The entity view display holding the display options configured for the
* entity components.
* @param string $view_mode
* The view mode that should be used to prepare the entity.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:391
public getCacheTags() {@inheritdoc}
$0['#pre_render'][0][0]->getCacheTags()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:396
public resetCache(?array $entities = null) {@inheritdoc}
$0['#pre_render'][0][0]->resetCache()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:403
protected isViewModeCacheable($view_mode): bool Determines whether the view mode is cacheable.
/**
* Determines whether the view mode is cacheable.
*
* @param string $view_mode
* Name of the view mode that should be rendered.
*
* @return bool
* TRUE if the view mode can be cached, FALSE otherwise.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:436
public viewField(Drupal\Core\Field\FieldItemListInterface $items, $display_options = array()) {@inheritdoc}
$0['#pre_render'][0][0]->viewField()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:448
public viewFieldItem(Drupal\Core\Field\FieldItemInterface $item, $display = array()) {@inheritdoc}
$0['#pre_render'][0][0]->viewFieldItem()
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:473
protected getSingleFieldDisplay($entity, $field_name, $display_options): \Drupal\Core\Entity\Display\EntityViewDisplayInterface Gets an EntityViewDisplay for rendering an individual field.
/**
* Gets an EntityViewDisplay for rendering an individual field.
*
* @param \Drupal\Core\Entity\FieldableEntityInterface $entity
* The entity.
* @param string $field_name
* The field name.
* @param string|array $display_options
* The display options passed to the viewField() method.
*
* @return \Drupal\Core\Entity\Display\EntityViewDisplayInterface
* The EntityViewDisplay objects created for individual field rendering.
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:507
protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Gets the module handler.
/**
* Gets the module handler.
*
* @return \Drupal\Core\Extension\ModuleHandlerInterface
* The module handler.
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityHandlerBase.php:31
public setModuleHandler(Drupal\Core\Extension\ModuleHandlerInterface $module_handler): $this Sets the module handler for this handler.
$0['#pre_render'][0][0]->setModuleHandler()
/**
* Sets the module handler for this handler.
*
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
*
* @return $this
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityHandlerBase.php:46
protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.
/**
* 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
* @link https://www.drupal.org/node/322729 Localization API @endlink. When
* possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
* $this->t(). Otherwise create a new
* \Drupal\Core\StringTranslation\TranslatableMarkup object.
*
* @param string $string
* A string containing the English text to translate.
* @param 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.
* @param 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 \Drupal\Core\StringTranslation\TranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*
* @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
* @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
*
* @ingroup sanitization
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70
protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.
/**
* Formats a string containing a count of items.
*
* @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* An object that, when cast to a string, returns the translated string.
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83
protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.
/**
* Returns the number of plurals supported by a given language.
*
* @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
*
* @return int
* The number of plurals supported.
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95
protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.
/**
* Gets the string translation service.
*
* @return \Drupal\Core\StringTranslation\TranslationInterface
* The string translation service.
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109
public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.
$0['#pre_render'][0][0]->setStringTranslation()
/**
* Sets the string translation service to use.
*
* @param \Drupal\Core\StringTranslation\TranslationInterface $translation
* The string translation service.
*
* @return $this
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125
public __sleep(): array {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33
public __wakeup(): void {@inheritdoc}
/**
* {@inheritdoc}
*/
Inherited from Drupal\Core\Entity\EntityHandlerBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73
public static Drupal\Core\Entity\EntityViewBuilder::createInstance(Symfony\Component\DependencyInjection\ContainerInterface $container, Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:109
public static Drupal\Core\Entity\EntityViewBuilder::trustedCallbacks() {@inheritdoc}
/**
* {@inheritdoc}
*/
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityViewBuilder.php:138
public const Drupal\Core\Security\TrustedCallbackInterface::THROW_EXCEPTION :: string (9) "exception"
public const Drupal\Core\Security\TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION :: string (20) "silenced_deprecation"