Devel Load
- $0 Drupal\node\Entity\Node#1494 (25)
- Entity Fields (25)
- Properties (31)
- Methods (136)
- Static methods (19)
- Static properties (1)
- Class constants (9)
- Iterator
- nid -> string (3) "134"$0->nid->value
- uuid -> string (36) "8793de7f-ec8a-4d6f-99c8-d7fa0637c4e5"$0->uuid->value
- vid -> string (3) "136"$0->vid->value
- langcode -> string (2) "fr"$0->langcode->value
- type -> string (4) "page"$0->type->target_id
- revision_timestamp -> string (10) "1738020409"$0->revision_timestamp->value
2025-01-27T23:26:49+00:00
- revision_uid -> string (1) "1"$0->revision_uid->target_id
- revision_log -> Drupal\Core\Field\FieldItemList#8390 (0)$0->revision_log
- No values
- Properties (9)
- Methods (69)
- Static methods (2)
- Iterator
- No values uninitialized
- protected definition -> Drupal\Core\Field\BaseFieldDefinition#1569 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (9)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1570 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (20) "Revision log message"
- protected arguments -> array (0)
- protected translatedMarkup -> string (29) "Message du journal de version"
- protected options -> array (0)
- protected stringTranslation -> Drupal\webprofiler\StringTranslation\TranslationManagerWrapper#239 (5)
- Properties (5)
- Methods (12)
- protected translators -> array (2)
- 30 => array (1) Depth Limit
- 0 => array (1) Depth Limit
- protected sortedTranslators -> array (2)
- 0 => Drupal\Core\StringTranslation\Translator\CustomStrings#272 Depth Limit
- 1 => Drupal\locale\LocaleTranslation#261 Depth Limit
- protected defaultLangcode -> string (2) "fr"
- private translated -> array (31)
- ID => string (16) "Identifiant (ID)"
- UUID => string (35) "Identifiant universel unique (UUID)"
- Revision ID => string (27) "Identifiant (ID) de version"
- Language => string (6) "Langue"
- Revision create time => UTF-8 string (32) "Heure de création de la version"
- The time that the current revision was created. => UTF-8 string (56) "La date à laquelle la version actuelle a été créée."
- Revision user => UTF-8 string (38) "Utilisateur à l'origine de la version"
- The user ID of the author of the current revision. => string (66) "L'identifiant (ID) utilisateur de l'auteur de la version actuelle."
- Revision log message => string (29) "Message du journal de version"
- Briefly describe the changes you have made. => UTF-8 string (50) "Décrire brièvement les modifications apportées."
- Published => UTF-8 string (7) "Publié"
- On => string (2) "On"
- Off => string (3) "Off"
- Authored by => UTF-8 string (10) "Écrit par"
- The username of the content author. => string (44) "Le nom d'utilisateur de l'auteur du contenu."
- Title => string (5) "Titre"
- Authored on => UTF-8 string (9) "Écrit le"
- The date and time that the content was created. => UTF-8 string (56) "La date et l'heure auxquelles le contenu a été créé."
- Changed => UTF-8 string (8) "Modifié"
- The time that the node was last edited. => UTF-8 string (69) "La date à laquelle le nœud a été modifié pour la dernière fois."
- Sticky at top of lists => UTF-8 string (27) "Epinglé en haut des listes"
- Default translation => UTF-8 string (22) "Traduction par défaut"
- A flag indicating whether this is the default translation. => UTF-8 string (63) "Un marqueur indiquant s'il s'agit de la traduction par défaut."
- Default revision => UTF-8 string (19) "Version par défaut"
- A flag indicating whether this was a default revision when it was saved. => UTF-8 string (100) "Un marqueur indiquant si ceci était la version par défaut au moment où elle ...
Un marqueur indiquant si ceci était la version par défaut au moment où elle a été enregistrée.
- Revision translation affected => UTF-8 string (31) "Traduction de version impactée"
- Indicates if the last edit of a translation belongs to current revision. => UTF-8 string (88) "Indique si la dernière modification d'une traduction appartient à la version...
Indique si la dernière modification d'une traduction appartient à la version actuelle.
- Metatags (Hidden field for JSON support) => UTF-8 string (59) "Balises meta (champ caché pour la prise en charge du JSON)"
- URL alias => string (11) "Alias d'URL"
- Menu link => string (12) "Lien du menu"
- Computed menu link for the node (only available during node saving). => UTF-8 string (94) "Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistr...
Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistrement du nœud).
- private untranslated -> array (1)
- The computed meta tags for the entity. => string (38) "The computed meta tags for the entity."
- protected doTranslate($string, array $options = array()): string {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:31
- public getTranslated(): array Return the list of translated strings.
/** * Return the list of translated strings. * * @return string[] * The list of translated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:60
- public getUntranslated(): array Return the list of untranslated strings.
/** * Return the list of untranslated strings. * * @return string[] * The list of untranslated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:70
- 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
- public getStringTranslation($langcode, $string, $context) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87
- public translate($string, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104
- public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112
- public formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158
- public reset() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 (29) "Message du journal de version"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1571 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (43) "Briefly describe the changes you have made."
- protected arguments -> array (0)
- protected translatedMarkup -> UTF-8 string (50) "Décrire brièvement les modifications apportées."
- protected options -> array (0)
- protected stringTranslation -> Drupal\webprofiler\StringTranslation\TranslationManagerWrapper#239 (5)
- Properties (5)
- Methods (12)
- protected translators -> array (2)
- 30 => array (1) Depth Limit
- 0 => array (1) Depth Limit
- protected sortedTranslators -> array (2)
- 0 => Drupal\Core\StringTranslation\Translator\CustomStrings#272 Depth Limit
- 1 => Drupal\locale\LocaleTranslation#261 Depth Limit
- protected defaultLangcode -> string (2) "fr"
- private translated -> array (31)
- ID => string (16) "Identifiant (ID)"
- UUID => string (35) "Identifiant universel unique (UUID)"
- Revision ID => string (27) "Identifiant (ID) de version"
- Language => string (6) "Langue"
- Revision create time => UTF-8 string (32) "Heure de création de la version"
- The time that the current revision was created. => UTF-8 string (56) "La date à laquelle la version actuelle a été créée."
- Revision user => UTF-8 string (38) "Utilisateur à l'origine de la version"
- The user ID of the author of the current revision. => string (66) "L'identifiant (ID) utilisateur de l'auteur de la version actuelle."
- Revision log message => string (29) "Message du journal de version"
- Briefly describe the changes you have made. => UTF-8 string (50) "Décrire brièvement les modifications apportées."
- Published => UTF-8 string (7) "Publié"
- On => string (2) "On"
- Off => string (3) "Off"
- Authored by => UTF-8 string (10) "Écrit par"
- The username of the content author. => string (44) "Le nom d'utilisateur de l'auteur du contenu."
- Title => string (5) "Titre"
- Authored on => UTF-8 string (9) "Écrit le"
- The date and time that the content was created. => UTF-8 string (56) "La date et l'heure auxquelles le contenu a été créé."
- Changed => UTF-8 string (8) "Modifié"
- The time that the node was last edited. => UTF-8 string (69) "La date à laquelle le nœud a été modifié pour la dernière fois."
- Sticky at top of lists => UTF-8 string (27) "Epinglé en haut des listes"
- Default translation => UTF-8 string (22) "Traduction par défaut"
- A flag indicating whether this is the default translation. => UTF-8 string (63) "Un marqueur indiquant s'il s'agit de la traduction par défaut."
- Default revision => UTF-8 string (19) "Version par défaut"
- A flag indicating whether this was a default revision when it was saved. => UTF-8 string (100) "Un marqueur indiquant si ceci était la version par défaut au moment où elle ...
Un marqueur indiquant si ceci était la version par défaut au moment où elle a été enregistrée.
- Revision translation affected => UTF-8 string (31) "Traduction de version impactée"
- Indicates if the last edit of a translation belongs to current revision. => UTF-8 string (88) "Indique si la dernière modification d'une traduction appartient à la version...
Indique si la dernière modification d'une traduction appartient à la version actuelle.
- Metatags (Hidden field for JSON support) => UTF-8 string (59) "Balises meta (champ caché pour la prise en charge du JSON)"
- URL alias => string (11) "Alias d'URL"
- Menu link => string (12) "Lien du menu"
- Computed menu link for the node (only available during node saving). => UTF-8 string (94) "Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistr...
Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistrement du nœud).
- private untranslated -> array (1)
- The computed meta tags for the entity. => string (38) "The computed meta tags for the entity."
- protected doTranslate($string, array $options = array()): string {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:31
- public getTranslated(): array Return the list of translated strings.
/** * Return the list of translated strings. * * @return string[] * The list of translated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:60
- public getUntranslated(): array Return the list of untranslated strings.
/** * Return the list of untranslated strings. * * @return string[] * The list of untranslated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:70
- 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
- public getStringTranslation($langcode, $string, $context) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87
- public translate($string, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104
- public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112
- public formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158
- public reset() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 UTF-8 string (50) "Décrire brièvement les modifications apportées."
- revisionable => boolean true
- default_value => array (1)
- 0 => array (1)
- value => string (0) ""
- display => array (1)
- form => array (1)
- options => array (3)
- type => string (15) "string_textarea"
- weight => integer 25
- settings => array (1) Depth Limit
- provider => string (4) "node"
- field_name => string (12) "revision_log"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1572 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (22) "field_item:string_long"
- settings => array (1)
- case_sensitive => boolean false
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1569 Recursion
- 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
- protected type -> string (11) "string_long"
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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 name -> string (12) "revision_log"
- protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#8250 Blacklisted
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected list -> array (0)
- protected langcode -> string (2) "fr"
- protected createItem($offset = 0, $value = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44
- public getEntity() {@inheritdoc}$0->revision_log->getEntity()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51
- public setLangcode($langcode) {@inheritdoc}$0->revision_log->setLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60
- public getLangcode() {@inheritdoc}$0->revision_log->getLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67
- public getFieldDefinition() {@inheritdoc}$0->revision_log->getFieldDefinition()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74
- public getSettings() {@inheritdoc}$0->revision_log->getSettings()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81
- public getSetting($setting_name) {@inheritdoc}$0->revision_log->getSetting()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88
- public filterEmptyItems() {@inheritdoc}$0->revision_log->filterEmptyItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95
- public setValue($values, $notify = true) {@inheritdoc}$0->revision_log->setValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105
- public __get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117
- public __set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127
- public __isset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137
- public __unset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0->revision_log->access()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156
- public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}$0->revision_log->defaultAccess()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164
- public applyDefaultValue($notify = true) {@inheritdoc}$0->revision_log->applyDefaultValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172
- public preSave() {@inheritdoc}$0->revision_log->preSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191
- public postSave($update) {@inheritdoc}$0->revision_log->postSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201
- public delete() {@inheritdoc}$0->revision_log->delete()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209
- public deleteRevision() {@inheritdoc}$0->revision_log->deleteRevision()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231
- public view($display_options = array()) {@inheritdoc}$0->revision_log->view()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
- public generateSampleItems($count = 1) {@inheritdoc}$0->revision_log->generateSampleItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253
- public getConstraints() {@inheritdoc}$0->revision_log->getConstraints()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->revision_log->defaultValuesForm()
/** * {@inheritdoc} */ 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->revision_log->defaultValuesFormValidate()
/** * {@inheritdoc} */ 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->revision_log->defaultValuesFormSubmit()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
- public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}$0->revision_log->equals()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
- public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}$0->revision_log->hasAffectingChanges()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449
- public getValue() {@inheritdoc}$0->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log->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->revision_log
/** * 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->revision_log->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\FieldItemList()
/** * 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->revision_log->getPluginId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
- public getPluginDefinition() {@inheritdoc}$0->revision_log->getPluginDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
- public getDataDefinition() {@inheritdoc}$0->revision_log->getDataDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
- public validate() {@inheritdoc}$0->revision_log->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->revision_log->setContext()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
- public getName() {@inheritdoc}$0->revision_log->getName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
- public getRoot() {@inheritdoc}$0->revision_log->getRoot()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
- public getPropertyPath() {@inheritdoc}$0->revision_log->getPropertyPath()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
- public getParent() {@inheritdoc}$0->revision_log->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->revision_log->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->revision_log->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->revision_log->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
- public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklistediterator_to_array($0->revision_log, false)
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
- status -> string (1) "1"$0->status->value
- uid -> string (1) "1"$0->uid->target_id
- title -> UTF-8 string (38) "Les Mélodistes et leur belle histoire"$0->title->value
- created -> string (10) "1738020409"$0->created->value
2025-01-27T23:26:49+00:00
- changed -> string (10) "1738594765"$0->changed->value
2025-02-03T14:59:25+00:00
- promote -> string (1) "0"$0->promote->value
- sticky -> string (1) "0"$0->sticky->value
- default_langcode -> string (1) "1"$0->default_langcode->value
- revision_default -> string (1) "1"$0->revision_default->value
- revision_translation_affected -> string (1) "1"$0->revision_translation_affected->value
- metatag -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8459 (3)$0->metatag
- Values (3)
- Properties (11)
- Methods (72)
- Static methods (2)
- Iterator
- 0 => array (2)$0->metatag->getValue()[0]
- tag => string (4) "meta"$0->metatag->getValue()[0]['tag']
- attributes => array (2)$0->metatag->getValue()[0]['attributes']
- name => string (5) "title"$0->metatag->getValue()[0]['attributes']['name']
- content => UTF-8 string (27) "Les Mélodistes de Brossard"$0->metatag->getValue()[0]['attributes']['content']
- name => string (5) "title"
- tag => string (4) "meta"
- 1 => array (2)$0->metatag->getValue()[1]
- tag => string (4) "meta"$0->metatag->getValue()[1]['tag']
- attributes => array (2)$0->metatag->getValue()[1]['attributes']
- name => string (11) "description"$0->metatag->getValue()[1]['attributes']['name']
- content => UTF-8 string (43) "Services et activités pour les 50 ans et +"$0->metatag->getValue()[1]['attributes']['content']
- name => string (11) "description"
- tag => string (4) "meta"
- 2 => array (2)$0->metatag->getValue()[2]
- tag => string (4) "link"$0->metatag->getValue()[2]['tag']
- attributes => array (2)$0->metatag->getValue()[2]['attributes']
- rel => string (9) "canonical"$0->metatag->getValue()[2]['attributes']['rel']
- href => string (44) "http://melodistesbrossard.org/notre-histoire"$0->metatag->getValue()[2]['attributes']['href']
- rel => string (9) "canonical"
- tag => string (4) "link"
- 0 => array (2)
- protected definition -> Drupal\Core\Field\BaseFieldDefinition#1621 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (10)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1622 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (40) "Metatags (Hidden field for JSON support)"
- protected arguments -> array (0)
- protected translatedMarkup -> UTF-8 string (59) "Balises meta (champ caché pour la prise en charge du JSON)"
- protected options -> array (0)
- protected stringTranslation -> Drupal\webprofiler\StringTranslation\TranslationManagerWrapper#239 (5)
- Properties (5)
- Methods (12)
- protected translators -> array (2)
- 30 => array (1) Depth Limit
- 0 => array (1) Depth Limit
- protected sortedTranslators -> array (2)
- 0 => Drupal\Core\StringTranslation\Translator\CustomStrings#272 Depth Limit
- 1 => Drupal\locale\LocaleTranslation#261 Depth Limit
- protected defaultLangcode -> string (2) "fr"
- private translated -> array (60)
- ID => string (16) "Identifiant (ID)"
- UUID => string (35) "Identifiant universel unique (UUID)"
- Revision ID => string (27) "Identifiant (ID) de version"
- Language => string (6) "Langue"
- Revision create time => UTF-8 string (32) "Heure de création de la version"
- The time that the current revision was created. => UTF-8 string (56) "La date à laquelle la version actuelle a été créée."
- Revision user => UTF-8 string (38) "Utilisateur à l'origine de la version"
- The user ID of the author of the current revision. => string (66) "L'identifiant (ID) utilisateur de l'auteur de la version actuelle."
- Revision log message => string (29) "Message du journal de version"
- Briefly describe the changes you have made. => UTF-8 string (50) "Décrire brièvement les modifications apportées."
- Published => UTF-8 string (7) "Publié"
- On => string (2) "On"
- Off => string (3) "Off"
- Authored by => UTF-8 string (10) "Écrit par"
- The username of the content author. => string (44) "Le nom d'utilisateur de l'auteur du contenu."
- Title => string (5) "Titre"
- Authored on => UTF-8 string (9) "Écrit le"
- The date and time that the content was created. => UTF-8 string (56) "La date et l'heure auxquelles le contenu a été créé."
- Changed => UTF-8 string (8) "Modifié"
- The time that the node was last edited. => UTF-8 string (69) "La date à laquelle le nœud a été modifié pour la dernière fois."
- Sticky at top of lists => UTF-8 string (27) "Epinglé en haut des listes"
- Default translation => UTF-8 string (22) "Traduction par défaut"
- A flag indicating whether this is the default translation. => UTF-8 string (63) "Un marqueur indiquant s'il s'agit de la traduction par défaut."
- Default revision => UTF-8 string (19) "Version par défaut"
- A flag indicating whether this was a default revision when it was saved. => UTF-8 string (100) "Un marqueur indiquant si ceci était la version par défaut au moment où elle ...
Un marqueur indiquant si ceci était la version par défaut au moment où elle a été enregistrée.
- Revision translation affected => UTF-8 string (31) "Traduction de version impactée"
- Indicates if the last edit of a translation belongs to current revision. => UTF-8 string (88) "Indique si la dernière modification d'une traduction appartient à la version...
Indique si la dernière modification d'une traduction appartient à la version actuelle.
- Metatags (Hidden field for JSON support) => UTF-8 string (59) "Balises meta (champ caché pour la prise en charge du JSON)"
- URL alias => string (11) "Alias d'URL"
- Menu link => string (12) "Lien du menu"
- Computed menu link for the node (only available during node saving). => UTF-8 string (94) "Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistr...
Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistrement du nœud).
- Author => string (6) "Auteur"
- Rights => string (6) "Droits"
- Google => string (6) "Google"
- ICBM => string (4) "ICBM"
- Robots => string (6) "Robots"
- Geographical place name => UTF-8 string (25) "Nom de lieu géographique"
- Page title => string (10) "Page title"
- Cache control => UTF-8 string (18) "Contrôle du cache"
- Image => string (16) "In-page Image(s)"
- Pragma => string (6) "Pragma"
- Previous page URL => UTF-8 string (27) "URL de la page précédente"
- Next page URL => string (23) "URL de la page suivante"
- Revisit After => string (13) "Revisit After"
- Set cookie => UTF-8 string (18) "Définir le cookie"
- Abstract => UTF-8 string (8) "Résumé"
- Description => string (11) "Description"
- Canonical URL => string (13) "URL canonique"
- Geographical region => UTF-8 string (21) "Région géographique"
- Geographical position => UTF-8 string (22) "Position géographique"
- Expires => string (6) "Expire"
- Generator => UTF-8 string (12) "Générateur"
- Shortlink URL => string (14) "URL raccourcie"
- Refresh => UTF-8 string (11) "Rafraîchir"
- Original source => string (16) "Source originale"
- Rating => string (4) "Note"
- Keywords => UTF-8 string (10) "Mots-clés"
- Referrer policy => UTF-8 string (28) "Politique de référencement"
- Basic tags => string (15) "Balises de base"
- Advanced => UTF-8 string (7) "Avancé"
- private untranslated -> array (1)
- The computed meta tags for the entity. => string (38) "The computed meta tags for the entity."
- protected doTranslate($string, array $options = array()): string {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:31
- public getTranslated(): array Return the list of translated strings.
/** * Return the list of translated strings. * * @return string[] * The list of translated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:60
- public getUntranslated(): array Return the list of untranslated strings.
/** * Return the list of untranslated strings. * * @return string[] * The list of untranslated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:70
- 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
- public getStringTranslation($langcode, $string, $context) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87
- public translate($string, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104
- public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112
- public formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158
- public reset() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 UTF-8 string (59) "Balises meta (champ caché pour la prise en charge du JSON)"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1623 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (38) "The computed meta tags for the entity."
- protected arguments -> array (0)
- protected translatedMarkup -> string (38) "The computed meta tags for the entity."
- protected options -> array (0)
- protected stringTranslation -> Drupal\webprofiler\StringTranslation\TranslationManagerWrapper#239 (5)
- Properties (5)
- Methods (12)
- protected translators -> array (2)
- 30 => array (1) Depth Limit
- 0 => array (1) Depth Limit
- protected sortedTranslators -> array (2)
- 0 => Drupal\Core\StringTranslation\Translator\CustomStrings#272 Depth Limit
- 1 => Drupal\locale\LocaleTranslation#261 Depth Limit
- protected defaultLangcode -> string (2) "fr"
- private translated -> array (60)
- ID => string (16) "Identifiant (ID)"
- UUID => string (35) "Identifiant universel unique (UUID)"
- Revision ID => string (27) "Identifiant (ID) de version"
- Language => string (6) "Langue"
- Revision create time => UTF-8 string (32) "Heure de création de la version"
- The time that the current revision was created. => UTF-8 string (56) "La date à laquelle la version actuelle a été créée."
- Revision user => UTF-8 string (38) "Utilisateur à l'origine de la version"
- The user ID of the author of the current revision. => string (66) "L'identifiant (ID) utilisateur de l'auteur de la version actuelle."
- Revision log message => string (29) "Message du journal de version"
- Briefly describe the changes you have made. => UTF-8 string (50) "Décrire brièvement les modifications apportées."
- Published => UTF-8 string (7) "Publié"
- On => string (2) "On"
- Off => string (3) "Off"
- Authored by => UTF-8 string (10) "Écrit par"
- The username of the content author. => string (44) "Le nom d'utilisateur de l'auteur du contenu."
- Title => string (5) "Titre"
- Authored on => UTF-8 string (9) "Écrit le"
- The date and time that the content was created. => UTF-8 string (56) "La date et l'heure auxquelles le contenu a été créé."
- Changed => UTF-8 string (8) "Modifié"
- The time that the node was last edited. => UTF-8 string (69) "La date à laquelle le nœud a été modifié pour la dernière fois."
- Sticky at top of lists => UTF-8 string (27) "Epinglé en haut des listes"
- Default translation => UTF-8 string (22) "Traduction par défaut"
- A flag indicating whether this is the default translation. => UTF-8 string (63) "Un marqueur indiquant s'il s'agit de la traduction par défaut."
- Default revision => UTF-8 string (19) "Version par défaut"
- A flag indicating whether this was a default revision when it was saved. => UTF-8 string (100) "Un marqueur indiquant si ceci était la version par défaut au moment où elle ...
Un marqueur indiquant si ceci était la version par défaut au moment où elle a été enregistrée.
- Revision translation affected => UTF-8 string (31) "Traduction de version impactée"
- Indicates if the last edit of a translation belongs to current revision. => UTF-8 string (88) "Indique si la dernière modification d'une traduction appartient à la version...
Indique si la dernière modification d'une traduction appartient à la version actuelle.
- Metatags (Hidden field for JSON support) => UTF-8 string (59) "Balises meta (champ caché pour la prise en charge du JSON)"
- URL alias => string (11) "Alias d'URL"
- Menu link => string (12) "Lien du menu"
- Computed menu link for the node (only available during node saving). => UTF-8 string (94) "Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistr...
Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistrement du nœud).
- Author => string (6) "Auteur"
- Rights => string (6) "Droits"
- Google => string (6) "Google"
- ICBM => string (4) "ICBM"
- Robots => string (6) "Robots"
- Geographical place name => UTF-8 string (25) "Nom de lieu géographique"
- Page title => string (10) "Page title"
- Cache control => UTF-8 string (18) "Contrôle du cache"
- Image => string (16) "In-page Image(s)"
- Pragma => string (6) "Pragma"
- Previous page URL => UTF-8 string (27) "URL de la page précédente"
- Next page URL => string (23) "URL de la page suivante"
- Revisit After => string (13) "Revisit After"
- Set cookie => UTF-8 string (18) "Définir le cookie"
- Abstract => UTF-8 string (8) "Résumé"
- Description => string (11) "Description"
- Canonical URL => string (13) "URL canonique"
- Geographical region => UTF-8 string (21) "Région géographique"
- Geographical position => UTF-8 string (22) "Position géographique"
- Expires => string (6) "Expire"
- Generator => UTF-8 string (12) "Générateur"
- Shortlink URL => string (14) "URL raccourcie"
- Refresh => UTF-8 string (11) "Rafraîchir"
- Original source => string (16) "Source originale"
- Rating => string (4) "Note"
- Keywords => UTF-8 string (10) "Mots-clés"
- Referrer policy => UTF-8 string (28) "Politique de référencement"
- Basic tags => string (15) "Balises de base"
- Advanced => UTF-8 string (7) "Avancé"
- private untranslated -> array (1)
- The computed meta tags for the entity. => string (38) "The computed meta tags for the entity."
- protected doTranslate($string, array $options = array()): string {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:31
- public getTranslated(): array Return the list of translated strings.
/** * Return the list of translated strings. * * @return string[] * The list of translated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:60
- public getUntranslated(): array Return the list of untranslated strings.
/** * Return the list of untranslated strings. * * @return string[] * The list of untranslated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:70
- 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
- public getStringTranslation($langcode, $string, $context) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87
- public translate($string, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104
- public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112
- public formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158
- public reset() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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."
- computed => boolean true
- translatable => boolean true
- read-only => boolean true
- entity_type => string (4) "node"
- cardinality => integer -1
- provider => string (7) "metatag"
- field_name => string (7) "metatag"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1624 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (27) "field_item:metatag_computed"
- settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1621 Recursion
- 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
- protected type -> string (16) "metatag_computed"
- protected propertyDefinitions -> array (2)
- tag => Drupal\Core\TypedData\DataDefinition#9774 (2)
- Properties (2)
- Methods (34)
- Static methods (2)
- protected definition -> array (3)
- type => string (6) "string"
- label => Drupal\Core\StringTranslation\TranslatableMarkup#9773 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (3) "Tag"
- 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 UTF-8 string (10) "Étiquette"
- required => boolean true
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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
- attributes => Drupal\Core\TypedData\MapDataDefinition#9875 (4)
- Properties (4)
- Methods (39)
- Static methods (4)
- protected definition -> array (3)
- type => string (3) "map"
- label => Drupal\Core\StringTranslation\TranslatableMarkup#9776 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (4) "Name"
- 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 (3) "Nom"
- required => boolean true
- protected typedDataManager -> null
- protected propertyDefinitions -> null
- protected mainPropertyName -> null
- public getPropertyDefinitions() {@inheritdoc}
/** * {@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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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 name -> string (7) "metatag"
- protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#8250 Blacklisted
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected list -> array (3)
- 0 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#9853 (9)
- Properties (9)
- Methods (49)
- Static methods (18)
- Iterator
- protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1624 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (27) "field_item:metatag_computed"
- settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1621 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (10)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1622 Depth Limit
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1623 Depth Limit
- computed => boolean true
- translatable => boolean true
- read-only => boolean true
- entity_type => string (4) "node"
- cardinality => integer -1
- provider => string (7) "metatag"
- field_name => string (7) "metatag"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1624 Recursion
- protected type -> string (16) "metatag_computed"
- protected propertyDefinitions -> array (2)
- tag => Drupal\Core\TypedData\DataDefinition#9774 Depth Limit
- attributes => Drupal\Core\TypedData\MapDataDefinition#9875 Depth Limit
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- protected name -> integer 0
- protected parent -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8459 Recursion
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected values -> array (2)
- tag => string (4) "meta"
- attributes => array (2)
- name => string (5) "title"
- content => UTF-8 string (27) "Les Mélodistes de Brossard"
- protected properties -> array (0)
- public isEmpty() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:47
- public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}
/** * {@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
- protected writePropertyValue($property_name, $value) {@inheritdoc}
/** * {@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:56
- public getString() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
- 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:116
- 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:131
- 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:163
- public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
- public getIterator(): ArrayIterator {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:187
- 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:214
- 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:231
- 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:241
- 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
- public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@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
- Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted
- 1 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#9852 (9)
- Properties (9)
- Methods (49)
- Static methods (18)
- Iterator
- protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1624 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (27) "field_item:metatag_computed"
- settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1621 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (10)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1622 Depth Limit
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1623 Depth Limit
- computed => boolean true
- translatable => boolean true
- read-only => boolean true
- entity_type => string (4) "node"
- cardinality => integer -1
- provider => string (7) "metatag"
- field_name => string (7) "metatag"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1624 Recursion
- protected type -> string (16) "metatag_computed"
- protected propertyDefinitions -> array (2)
- tag => Drupal\Core\TypedData\DataDefinition#9774 Depth Limit
- attributes => Drupal\Core\TypedData\MapDataDefinition#9875 Depth Limit
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- protected name -> integer 1
- protected parent -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8459 Recursion
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected values -> array (2)
- tag => string (4) "meta"
- attributes => array (2)
- name => string (11) "description"
- content => UTF-8 string (43) "Services et activités pour les 50 ans et +"
- protected properties -> array (0)
- public isEmpty() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:47
- public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}
/** * {@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
- protected writePropertyValue($property_name, $value) {@inheritdoc}
/** * {@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:56
- public getString() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
- 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:116
- 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:131
- 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:163
- public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
- public getIterator(): ArrayIterator {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:187
- 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:214
- 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:231
- 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:241
- 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
- public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@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
- Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted
- 2 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#9881 (9)
- Properties (9)
- Methods (49)
- Static methods (18)
- Iterator
- protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1624 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (27) "field_item:metatag_computed"
- settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1621 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (10)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1622 Depth Limit
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1623 Depth Limit
- computed => boolean true
- translatable => boolean true
- read-only => boolean true
- entity_type => string (4) "node"
- cardinality => integer -1
- provider => string (7) "metatag"
- field_name => string (7) "metatag"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1624 Recursion
- protected type -> string (16) "metatag_computed"
- protected propertyDefinitions -> array (2)
- tag => Drupal\Core\TypedData\DataDefinition#9774 Depth Limit
- attributes => Drupal\Core\TypedData\MapDataDefinition#9875 Depth Limit
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- protected name -> integer 2
- protected parent -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8459 Recursion
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected values -> array (2)
- tag => string (4) "link"
- attributes => array (2)
- rel => string (9) "canonical"
- href => string (44) "http://melodistesbrossard.org/notre-histoire"
- protected properties -> array (0)
- public isEmpty() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:47
- public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}
/** * {@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
- protected writePropertyValue($property_name, $value) {@inheritdoc}
/** * {@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:56
- public getString() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
- 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:116
- 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:131
- 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:163
- public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
- public getIterator(): ArrayIterator {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:187
- 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:214
- 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:231
- 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:241
- 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
- public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@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
- Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted
- protected langcode -> string (2) "fr"
- protected metatagsGenerated -> boolean true
- protected valueComputed -> boolean true
- protected valueNeedsRecomputing() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/MetatagEntityFieldItemList.php:30
- protected computeValue() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/MetatagEntityFieldItemList.php:37
- protected createItem($offset = 0, $value = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44
- public getEntity() {@inheritdoc}$0->metatag->getEntity()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51
- public setLangcode($langcode) {@inheritdoc}$0->metatag->setLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60
- public getLangcode() {@inheritdoc}$0->metatag->getLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67
- public getFieldDefinition() {@inheritdoc}$0->metatag->getFieldDefinition()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74
- public getSettings() {@inheritdoc}$0->metatag->getSettings()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81
- public getSetting($setting_name) {@inheritdoc}$0->metatag->getSetting()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88
- public filterEmptyItems() {@inheritdoc}$0->metatag->filterEmptyItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95
- public setValue($values, $notify = true) {@inheritdoc}$0->metatag->setValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:50
- public __get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117
- public __set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127
- public __isset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137
- public __unset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0->metatag->access()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156
- public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}$0->metatag->defaultAccess()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164
- public applyDefaultValue($notify = true) {@inheritdoc}$0->metatag->applyDefaultValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:145
- public preSave() {@inheritdoc}$0->metatag->preSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191
- public postSave($update) {@inheritdoc}$0->metatag->postSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201
- public delete() {@inheritdoc}$0->metatag->delete()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209
- public deleteRevision() {@inheritdoc}$0->metatag->deleteRevision()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231
- public view($display_options = array()) {@inheritdoc}$0->metatag->view()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
- public generateSampleItems($count = 1) {@inheritdoc}$0->metatag->generateSampleItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253
- public getConstraints() {@inheritdoc}$0->metatag->getConstraints()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->metatag->defaultValuesForm()
/** * {@inheritdoc} */ 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->metatag->defaultValuesFormValidate()
/** * {@inheritdoc} */ 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->metatag->defaultValuesFormSubmit()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
- public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}$0->metatag->equals()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
- public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}$0->metatag->hasAffectingChanges()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449
- public getValue() {@inheritdoc}$0->metatag->getValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42
- public getString() {@inheritdoc}$0->metatag->getString()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61
- public get($index) {@inheritdoc}$0->metatag->get()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69
- public set($index, $value) {@inheritdoc}$0->metatag->set()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89
- public removeItem($index) {@inheritdoc}$0->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->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->metatag->offsetExists()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:121
- public offsetUnset($offset): void {@inheritdoc}$0->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->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->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->metatag->appendItem()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97
- public getItemDefinition() {@inheritdoc}$0->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->metatag->getIterator()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:129
- public count(): int {@inheritdoc}$0->metatag->count()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:137
- public isEmpty() {@inheritdoc}$0->metatag->isEmpty()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113
- public filter($callback) {@inheritdoc}$0->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->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->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->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->metatag->getPluginId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
- public getPluginDefinition() {@inheritdoc}$0->metatag->getPluginDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
- public getDataDefinition() {@inheritdoc}$0->metatag->getDataDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
- public validate() {@inheritdoc}$0->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->metatag->setContext()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
- public getName() {@inheritdoc}$0->metatag->getName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
- public getRoot() {@inheritdoc}$0->metatag->getRoot()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
- public getPropertyPath() {@inheritdoc}$0->metatag->getPropertyPath()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
- public getParent() {@inheritdoc}$0->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->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->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->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 static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklistediterator_to_array($0->metatag, false)
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
- path -> Drupal\path\Plugin\Field\FieldType\PathFieldItemList#8461 (3)$0->path
- Field properties (3)
- Properties (10)
- Methods (71)
- Static methods (2)
- Iterator
- alias -> string (15) "/notre-histoire"$0->path->alias
- pid -> string (2) "59"$0->path->pid
- langcode -> string (2) "fr"$0->path->langcode
- alias -> string (15) "/notre-histoire"
- protected definition -> Drupal\Core\Field\BaseFieldDefinition#1625 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (8)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1626 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (9) "URL alias"
- protected arguments -> array (0)
- protected translatedMarkup -> string (11) "Alias d'URL"
- protected options -> array (0)
- protected stringTranslation -> Drupal\webprofiler\StringTranslation\TranslationManagerWrapper#239 (5)
- Properties (5)
- Methods (12)
- protected translators -> array (2)
- 30 => array (1) Depth Limit
- 0 => array (1) Depth Limit
- protected sortedTranslators -> array (2)
- 0 => Drupal\Core\StringTranslation\Translator\CustomStrings#272 Depth Limit
- 1 => Drupal\locale\LocaleTranslation#261 Depth Limit
- protected defaultLangcode -> string (2) "fr"
- private translated -> array (62)
- ID => string (16) "Identifiant (ID)"
- UUID => string (35) "Identifiant universel unique (UUID)"
- Revision ID => string (27) "Identifiant (ID) de version"
- Language => string (6) "Langue"
- Revision create time => UTF-8 string (32) "Heure de création de la version"
- The time that the current revision was created. => UTF-8 string (56) "La date à laquelle la version actuelle a été créée."
- Revision user => UTF-8 string (38) "Utilisateur à l'origine de la version"
- The user ID of the author of the current revision. => string (66) "L'identifiant (ID) utilisateur de l'auteur de la version actuelle."
- Revision log message => string (29) "Message du journal de version"
- Briefly describe the changes you have made. => UTF-8 string (50) "Décrire brièvement les modifications apportées."
- Published => UTF-8 string (7) "Publié"
- On => string (2) "On"
- Off => string (3) "Off"
- Authored by => UTF-8 string (10) "Écrit par"
- The username of the content author. => string (44) "Le nom d'utilisateur de l'auteur du contenu."
- Title => string (5) "Titre"
- Authored on => UTF-8 string (9) "Écrit le"
- The date and time that the content was created. => UTF-8 string (56) "La date et l'heure auxquelles le contenu a été créé."
- Changed => UTF-8 string (8) "Modifié"
- The time that the node was last edited. => UTF-8 string (69) "La date à laquelle le nœud a été modifié pour la dernière fois."
- Sticky at top of lists => UTF-8 string (27) "Epinglé en haut des listes"
- Default translation => UTF-8 string (22) "Traduction par défaut"
- A flag indicating whether this is the default translation. => UTF-8 string (63) "Un marqueur indiquant s'il s'agit de la traduction par défaut."
- Default revision => UTF-8 string (19) "Version par défaut"
- A flag indicating whether this was a default revision when it was saved. => UTF-8 string (100) "Un marqueur indiquant si ceci était la version par défaut au moment où elle ...
Un marqueur indiquant si ceci était la version par défaut au moment où elle a été enregistrée.
- Revision translation affected => UTF-8 string (31) "Traduction de version impactée"
- Indicates if the last edit of a translation belongs to current revision. => UTF-8 string (88) "Indique si la dernière modification d'une traduction appartient à la version...
Indique si la dernière modification d'une traduction appartient à la version actuelle.
- Metatags (Hidden field for JSON support) => UTF-8 string (59) "Balises meta (champ caché pour la prise en charge du JSON)"
- URL alias => string (11) "Alias d'URL"
- Menu link => string (12) "Lien du menu"
- Computed menu link for the node (only available during node saving). => UTF-8 string (94) "Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistr...
Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistrement du nœud).
- Author => string (6) "Auteur"
- Rights => string (6) "Droits"
- Google => string (6) "Google"
- ICBM => string (4) "ICBM"
- Robots => string (6) "Robots"
- Geographical place name => UTF-8 string (25) "Nom de lieu géographique"
- Page title => string (10) "Page title"
- Cache control => UTF-8 string (18) "Contrôle du cache"
- Image => string (16) "In-page Image(s)"
- Pragma => string (6) "Pragma"
- Previous page URL => UTF-8 string (27) "URL de la page précédente"
- Next page URL => string (23) "URL de la page suivante"
- Revisit After => string (13) "Revisit After"
- Set cookie => UTF-8 string (18) "Définir le cookie"
- Abstract => UTF-8 string (8) "Résumé"
- Description => string (11) "Description"
- Canonical URL => string (13) "URL canonique"
- Geographical region => UTF-8 string (21) "Région géographique"
- Geographical position => UTF-8 string (22) "Position géographique"
- Expires => string (6) "Expire"
- Generator => UTF-8 string (12) "Générateur"
- Shortlink URL => string (14) "URL raccourcie"
- Refresh => UTF-8 string (11) "Rafraîchir"
- Original source => string (16) "Source originale"
- Rating => string (4) "Note"
- Keywords => UTF-8 string (10) "Mots-clés"
- Referrer policy => UTF-8 string (28) "Politique de référencement"
- Basic tags => string (15) "Balises de base"
- Advanced => UTF-8 string (7) "Avancé"
- Tag => UTF-8 string (10) "Étiquette"
- Name => string (3) "Nom"
- private untranslated -> array (1)
- The computed meta tags for the entity. => string (38) "The computed meta tags for the entity."
- protected doTranslate($string, array $options = array()): string {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:31
- public getTranslated(): array Return the list of translated strings.
/** * Return the list of translated strings. * * @return string[] * The list of translated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:60
- public getUntranslated(): array Return the list of untranslated strings.
/** * Return the list of untranslated strings. * * @return string[] * The list of untranslated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:70
- 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
- public getStringTranslation($langcode, $string, $context) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87
- public translate($string, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104
- public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112
- public formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158
- public reset() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 (11) "Alias d'URL"
- translatable => boolean true
- display => array (1)
- form => array (2)
- options => array (2)
- type => string (4) "path"
- weight => integer 30
- configurable => boolean true
- computed => boolean true
- provider => string (4) "path"
- field_name => string (4) "path"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1627 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (15) "field_item:path"
- settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1625 Recursion
- 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
- protected type -> string (4) "path"
- protected propertyDefinitions -> array (3)
- alias => Drupal\Core\TypedData\DataDefinition#1498 (2)
- Properties (2)
- Methods (34)
- Static methods (2)
- protected definition -> array (2)
- type => string (6) "string"
- label => Drupal\Core\StringTranslation\TranslatableMarkup#9896 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (10) "Path alias"
- 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 (15) "Alias de chemin"
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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
- pid => Drupal\Core\TypedData\DataDefinition#9895 (2)
- Properties (2)
- Methods (34)
- Static methods (2)
- protected definition -> array (2)
- type => string (7) "integer"
- label => Drupal\Core\StringTranslation\TranslatableMarkup#9887 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (7) "Path id"
- 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 (26) "Identifiant (ID) de chemin"
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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
- langcode => Drupal\Core\TypedData\DataDefinition#9898 (2)
- Properties (2)
- Methods (34)
- Static methods (2)
- protected definition -> array (2)
- type => string (6) "string"
- label => Drupal\Core\StringTranslation\TranslatableMarkup#9861 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (13) "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
- label string (17) "Code de la langue"
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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 name -> string (4) "path"
- protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#8250 Blacklisted
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected list -> array (1)
- 0 => Drupal\path\Plugin\Field\FieldType\PathItem#9893 (9)
- Properties (9)
- Methods (49)
- Static methods (20)
- Iterator
- protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1627 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (15) "field_item:path"
- settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1625 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (8)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1626 Depth Limit
- translatable => boolean true
- display => array (1) Depth Limit
- computed => boolean true
- provider => string (4) "path"
- field_name => string (4) "path"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1627 Recursion
- protected type -> string (4) "path"
- protected propertyDefinitions -> array (3)
- alias => Drupal\Core\TypedData\DataDefinition#1498 Depth Limit
- pid => Drupal\Core\TypedData\DataDefinition#9895 Depth Limit
- langcode => Drupal\Core\TypedData\DataDefinition#9898 Depth Limit
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- protected name -> integer 0
- protected parent -> Drupal\path\Plugin\Field\FieldType\PathFieldItemList#8461 Recursion
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected values -> array (3)
- alias => string (15) "/notre-histoire"
- pid => string (2) "59"
- langcode => string (2) "fr"
- protected properties -> array (0)
- public isEmpty() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:50
- public preSave() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:61
- public postSave($update) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathItem.php:71
- public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}
/** * {@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
- protected writePropertyValue($property_name, $value) {@inheritdoc}
/** * {@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:56
- public getString() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
- 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:116
- 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:131
- 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:163
- public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
- public getIterator(): ArrayIterator {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:187
- 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:214
- 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:231
- 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:241
- 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\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\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
- public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.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
- 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
- Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted
- protected langcode -> string (2) "fr"
- protected valueComputed -> boolean true
- protected computeValue() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathFieldItemList.php:21
- public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}$0->path->defaultAccess()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathFieldItemList.php:48
- public delete() {@inheritdoc}$0->path->delete()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/path/src/Plugin/Field/FieldType/PathFieldItemList.php:58
- protected createItem($offset = 0, $value = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44
- public getEntity() {@inheritdoc}$0->path->getEntity()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51
- public setLangcode($langcode) {@inheritdoc}$0->path->setLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60
- public getLangcode() {@inheritdoc}$0->path->getLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67
- public getFieldDefinition() {@inheritdoc}$0->path->getFieldDefinition()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74
- public getSettings() {@inheritdoc}$0->path->getSettings()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81
- public getSetting($setting_name) {@inheritdoc}$0->path->getSetting()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88
- public filterEmptyItems() {@inheritdoc}$0->path->filterEmptyItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95
- public setValue($values, $notify = true) {@inheritdoc}$0->path->setValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:50
- public __get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117
- public __set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127
- public __isset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137
- public __unset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0->path->access()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156
- public applyDefaultValue($notify = true) {@inheritdoc}$0->path->applyDefaultValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:145
- public preSave() {@inheritdoc}$0->path->preSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191
- public postSave($update) {@inheritdoc}$0->path->postSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201
- public deleteRevision() {@inheritdoc}$0->path->deleteRevision()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231
- public view($display_options = array()) {@inheritdoc}$0->path->view()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
- public generateSampleItems($count = 1) {@inheritdoc}$0->path->generateSampleItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253
- public getConstraints() {@inheritdoc}$0->path->getConstraints()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->path->defaultValuesForm()
/** * {@inheritdoc} */ 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->path->defaultValuesFormValidate()
/** * {@inheritdoc} */ 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->path->defaultValuesFormSubmit()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
- public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}$0->path->equals()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
- public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}$0->path->hasAffectingChanges()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449
- public getValue() {@inheritdoc}$0->path->getValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42
- public getString() {@inheritdoc}$0->path->getString()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61
- public get($index) {@inheritdoc}$0->path->get()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69
- public set($index, $value) {@inheritdoc}$0->path->set()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89
- public removeItem($index) {@inheritdoc}$0->path->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->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->path->offsetExists()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:121
- public offsetUnset($offset): void {@inheritdoc}$0->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->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->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->path->appendItem()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97
- public getItemDefinition() {@inheritdoc}$0->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->path->getIterator()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:129
- public count(): int {@inheritdoc}$0->path->count()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:137
- public isEmpty() {@inheritdoc}$0->path->isEmpty()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113
- public filter($callback) {@inheritdoc}$0->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->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->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->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\path\Plugin\Field\FieldType\PathFieldItemList()
/** * 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->path->getPluginId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
- public getPluginDefinition() {@inheritdoc}$0->path->getPluginDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
- public getDataDefinition() {@inheritdoc}$0->path->getDataDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
- public validate() {@inheritdoc}$0->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->path->setContext()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
- public getName() {@inheritdoc}$0->path->getName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
- public getRoot() {@inheritdoc}$0->path->getRoot()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
- public getPropertyPath() {@inheritdoc}$0->path->getPropertyPath()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
- public getParent() {@inheritdoc}$0->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->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->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->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. */ 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 static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklistediterator_to_array($0->path, false)
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
- menu_link -> Drupal\token\MenuLinkFieldItemList#8463 (0)$0->menu_link
- No values
- Properties (10)
- Methods (72)
- Static methods (3)
- Iterator
- No values uninitialized
- protected definition -> Drupal\Core\Field\BaseFieldDefinition#1628 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (12)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1629 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (9) "Menu link"
- protected arguments -> array (0)
- protected translatedMarkup -> string (12) "Lien du menu"
- protected options -> array (0)
- protected stringTranslation -> Drupal\webprofiler\StringTranslation\TranslationManagerWrapper#239 (5)
- Properties (5)
- Methods (12)
- protected translators -> array (2)
- 30 => array (1) Depth Limit
- 0 => array (1) Depth Limit
- protected sortedTranslators -> array (2)
- 0 => Drupal\Core\StringTranslation\Translator\CustomStrings#272 Depth Limit
- 1 => Drupal\locale\LocaleTranslation#261 Depth Limit
- protected defaultLangcode -> string (2) "fr"
- private translated -> array (65)
- ID => string (16) "Identifiant (ID)"
- UUID => string (35) "Identifiant universel unique (UUID)"
- Revision ID => string (27) "Identifiant (ID) de version"
- Language => string (6) "Langue"
- Revision create time => UTF-8 string (32) "Heure de création de la version"
- The time that the current revision was created. => UTF-8 string (56) "La date à laquelle la version actuelle a été créée."
- Revision user => UTF-8 string (38) "Utilisateur à l'origine de la version"
- The user ID of the author of the current revision. => string (66) "L'identifiant (ID) utilisateur de l'auteur de la version actuelle."
- Revision log message => string (29) "Message du journal de version"
- Briefly describe the changes you have made. => UTF-8 string (50) "Décrire brièvement les modifications apportées."
- Published => UTF-8 string (7) "Publié"
- On => string (2) "On"
- Off => string (3) "Off"
- Authored by => UTF-8 string (10) "Écrit par"
- The username of the content author. => string (44) "Le nom d'utilisateur de l'auteur du contenu."
- Title => string (5) "Titre"
- Authored on => UTF-8 string (9) "Écrit le"
- The date and time that the content was created. => UTF-8 string (56) "La date et l'heure auxquelles le contenu a été créé."
- Changed => UTF-8 string (8) "Modifié"
- The time that the node was last edited. => UTF-8 string (69) "La date à laquelle le nœud a été modifié pour la dernière fois."
- Sticky at top of lists => UTF-8 string (27) "Epinglé en haut des listes"
- Default translation => UTF-8 string (22) "Traduction par défaut"
- A flag indicating whether this is the default translation. => UTF-8 string (63) "Un marqueur indiquant s'il s'agit de la traduction par défaut."
- Default revision => UTF-8 string (19) "Version par défaut"
- A flag indicating whether this was a default revision when it was saved. => UTF-8 string (100) "Un marqueur indiquant si ceci était la version par défaut au moment où elle ...
Un marqueur indiquant si ceci était la version par défaut au moment où elle a été enregistrée.
- Revision translation affected => UTF-8 string (31) "Traduction de version impactée"
- Indicates if the last edit of a translation belongs to current revision. => UTF-8 string (88) "Indique si la dernière modification d'une traduction appartient à la version...
Indique si la dernière modification d'une traduction appartient à la version actuelle.
- Metatags (Hidden field for JSON support) => UTF-8 string (59) "Balises meta (champ caché pour la prise en charge du JSON)"
- URL alias => string (11) "Alias d'URL"
- Menu link => string (12) "Lien du menu"
- Computed menu link for the node (only available during node saving). => UTF-8 string (94) "Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistr...
Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistrement du nœud).
- Author => string (6) "Auteur"
- Rights => string (6) "Droits"
- Google => string (6) "Google"
- ICBM => string (4) "ICBM"
- Robots => string (6) "Robots"
- Geographical place name => UTF-8 string (25) "Nom de lieu géographique"
- Page title => string (10) "Page title"
- Cache control => UTF-8 string (18) "Contrôle du cache"
- Image => string (16) "In-page Image(s)"
- Pragma => string (6) "Pragma"
- Previous page URL => UTF-8 string (27) "URL de la page précédente"
- Next page URL => string (23) "URL de la page suivante"
- Revisit After => string (13) "Revisit After"
- Set cookie => UTF-8 string (18) "Définir le cookie"
- Abstract => UTF-8 string (8) "Résumé"
- Description => string (11) "Description"
- Canonical URL => string (13) "URL canonique"
- Geographical region => UTF-8 string (21) "Région géographique"
- Geographical position => UTF-8 string (22) "Position géographique"
- Expires => string (6) "Expire"
- Generator => UTF-8 string (12) "Générateur"
- Shortlink URL => string (14) "URL raccourcie"
- Refresh => UTF-8 string (11) "Rafraîchir"
- Original source => string (16) "Source originale"
- Rating => string (4) "Note"
- Keywords => UTF-8 string (10) "Mots-clés"
- Referrer policy => UTF-8 string (28) "Politique de référencement"
- Basic tags => string (15) "Balises de base"
- Advanced => UTF-8 string (7) "Avancé"
- Tag => UTF-8 string (10) "Étiquette"
- Name => string (3) "Nom"
- Path alias => string (15) "Alias de chemin"
- Path id => string (26) "Identifiant (ID) de chemin"
- Language Code => string (17) "Code de la langue"
- private untranslated -> array (1)
- The computed meta tags for the entity. => string (38) "The computed meta tags for the entity."
- protected doTranslate($string, array $options = array()): string {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:31
- public getTranslated(): array Return the list of translated strings.
/** * Return the list of translated strings. * * @return string[] * The list of translated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:60
- public getUntranslated(): array Return the list of untranslated strings.
/** * Return the list of untranslated strings. * * @return string[] * The list of untranslated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:70
- 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
- public getStringTranslation($langcode, $string, $context) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87
- public translate($string, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104
- public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112
- public formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158
- public reset() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 (12) "Lien du menu"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1630 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (68) "Computed menu link for the node (only available during node saving)."
- protected arguments -> array (0)
- protected translatedMarkup -> UTF-8 string (94) "Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistr...
Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistrement du nœud).
- protected options -> array (0)
- protected stringTranslation -> Drupal\webprofiler\StringTranslation\TranslationManagerWrapper#239 (5)
- Properties (5)
- Methods (12)
- protected translators -> array (2)
- 30 => array (1) Depth Limit
- 0 => array (1) Depth Limit
- protected sortedTranslators -> array (2)
- 0 => Drupal\Core\StringTranslation\Translator\CustomStrings#272 Depth Limit
- 1 => Drupal\locale\LocaleTranslation#261 Depth Limit
- protected defaultLangcode -> string (2) "fr"
- private translated -> array (65)
- ID => string (16) "Identifiant (ID)"
- UUID => string (35) "Identifiant universel unique (UUID)"
- Revision ID => string (27) "Identifiant (ID) de version"
- Language => string (6) "Langue"
- Revision create time => UTF-8 string (32) "Heure de création de la version"
- The time that the current revision was created. => UTF-8 string (56) "La date à laquelle la version actuelle a été créée."
- Revision user => UTF-8 string (38) "Utilisateur à l'origine de la version"
- The user ID of the author of the current revision. => string (66) "L'identifiant (ID) utilisateur de l'auteur de la version actuelle."
- Revision log message => string (29) "Message du journal de version"
- Briefly describe the changes you have made. => UTF-8 string (50) "Décrire brièvement les modifications apportées."
- Published => UTF-8 string (7) "Publié"
- On => string (2) "On"
- Off => string (3) "Off"
- Authored by => UTF-8 string (10) "Écrit par"
- The username of the content author. => string (44) "Le nom d'utilisateur de l'auteur du contenu."
- Title => string (5) "Titre"
- Authored on => UTF-8 string (9) "Écrit le"
- The date and time that the content was created. => UTF-8 string (56) "La date et l'heure auxquelles le contenu a été créé."
- Changed => UTF-8 string (8) "Modifié"
- The time that the node was last edited. => UTF-8 string (69) "La date à laquelle le nœud a été modifié pour la dernière fois."
- Sticky at top of lists => UTF-8 string (27) "Epinglé en haut des listes"
- Default translation => UTF-8 string (22) "Traduction par défaut"
- A flag indicating whether this is the default translation. => UTF-8 string (63) "Un marqueur indiquant s'il s'agit de la traduction par défaut."
- Default revision => UTF-8 string (19) "Version par défaut"
- A flag indicating whether this was a default revision when it was saved. => UTF-8 string (100) "Un marqueur indiquant si ceci était la version par défaut au moment où elle ...
Un marqueur indiquant si ceci était la version par défaut au moment où elle a été enregistrée.
- Revision translation affected => UTF-8 string (31) "Traduction de version impactée"
- Indicates if the last edit of a translation belongs to current revision. => UTF-8 string (88) "Indique si la dernière modification d'une traduction appartient à la version...
Indique si la dernière modification d'une traduction appartient à la version actuelle.
- Metatags (Hidden field for JSON support) => UTF-8 string (59) "Balises meta (champ caché pour la prise en charge du JSON)"
- URL alias => string (11) "Alias d'URL"
- Menu link => string (12) "Lien du menu"
- Computed menu link for the node (only available during node saving). => UTF-8 string (94) "Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistr...
Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistrement du nœud).
- Author => string (6) "Auteur"
- Rights => string (6) "Droits"
- Google => string (6) "Google"
- ICBM => string (4) "ICBM"
- Robots => string (6) "Robots"
- Geographical place name => UTF-8 string (25) "Nom de lieu géographique"
- Page title => string (10) "Page title"
- Cache control => UTF-8 string (18) "Contrôle du cache"
- Image => string (16) "In-page Image(s)"
- Pragma => string (6) "Pragma"
- Previous page URL => UTF-8 string (27) "URL de la page précédente"
- Next page URL => string (23) "URL de la page suivante"
- Revisit After => string (13) "Revisit After"
- Set cookie => UTF-8 string (18) "Définir le cookie"
- Abstract => UTF-8 string (8) "Résumé"
- Description => string (11) "Description"
- Canonical URL => string (13) "URL canonique"
- Geographical region => UTF-8 string (21) "Région géographique"
- Geographical position => UTF-8 string (22) "Position géographique"
- Expires => string (6) "Expire"
- Generator => UTF-8 string (12) "Générateur"
- Shortlink URL => string (14) "URL raccourcie"
- Refresh => UTF-8 string (11) "Rafraîchir"
- Original source => string (16) "Source originale"
- Rating => string (4) "Note"
- Keywords => UTF-8 string (10) "Mots-clés"
- Referrer policy => UTF-8 string (28) "Politique de référencement"
- Basic tags => string (15) "Balises de base"
- Advanced => UTF-8 string (7) "Avancé"
- Tag => UTF-8 string (10) "Étiquette"
- Name => string (3) "Nom"
- Path alias => string (15) "Alias de chemin"
- Path id => string (26) "Identifiant (ID) de chemin"
- Language Code => string (17) "Code de la langue"
- private untranslated -> array (1)
- The computed meta tags for the entity. => string (38) "The computed meta tags for the entity."
- protected doTranslate($string, array $options = array()): string {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:31
- public getTranslated(): array Return the list of translated strings.
/** * Return the list of translated strings. * * @return string[] * The list of translated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:60
- public getUntranslated(): array Return the list of untranslated strings.
/** * Return the list of untranslated strings. * * @return string[] * The list of untranslated strings. */ Defined in <drupal>/modules/contrib/webprofiler/src/StringTranslation/TranslationManagerWrapper.php:70
- 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79
- public getStringTranslation($langcode, $string, $context) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87
- public translate($string, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104
- public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112
- public formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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. */ Inherited from Drupal\Core\StringTranslation\TranslationManager Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158
- public reset() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\StringTranslation\TranslationManager 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 UTF-8 string (94) "Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistr...
Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistrement du nœud).
- revisionable => boolean true
- class => string (35) "\Drupal\token\MenuLinkFieldItemList"
- translatable => boolean true
- internal => boolean true
- display => array (2)
- view => array (1)
- options => array (2)
- label => string (6) "hidden"
- region => string (6) "hidden"
- form => array (1)
- options => array (1)
- region => string (6) "hidden"
- computed => boolean true
- provider => string (5) "token"
- field_name => string (9) "menu_link"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1631 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (27) "field_item:entity_reference"
- settings => array (3)
- target_type => string (17) "menu_link_content"
- handler => string (7) "default"
- handler_settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1628 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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 name -> string (9) "menu_link"
- protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#8250 Blacklisted
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected list -> array (0)
- protected langcode -> string (2) "fr"
- protected valueComputed -> boolean true
- protected computeValue() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/modules/contrib/token/src/MenuLinkFieldItemList.php:20
- public getConstraints() {@inheritdoc}$0->menu_link->getConstraints()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\EntityReferenceFieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:16
- public referencedEntities() {@inheritdoc}$0->menu_link->referencedEntities()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\EntityReferenceFieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:26
- public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->menu_link->defaultValuesFormSubmit()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\EntityReferenceFieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:107
- protected createItem($offset = 0, $value = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44
- public getEntity() {@inheritdoc}$0->menu_link->getEntity()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51
- public setLangcode($langcode) {@inheritdoc}$0->menu_link->setLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60
- public getLangcode() {@inheritdoc}$0->menu_link->getLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67
- public getFieldDefinition() {@inheritdoc}$0->menu_link->getFieldDefinition()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74
- public getSettings() {@inheritdoc}$0->menu_link->getSettings()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81
- public getSetting($setting_name) {@inheritdoc}$0->menu_link->getSetting()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88
- public filterEmptyItems() {@inheritdoc}$0->menu_link->filterEmptyItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95
- public setValue($values, $notify = true) {@inheritdoc}$0->menu_link->setValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:50
- public __get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117
- public __set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127
- public __isset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137
- public __unset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0->menu_link->access()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156
- public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}$0->menu_link->defaultAccess()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164
- public applyDefaultValue($notify = true) {@inheritdoc}$0->menu_link->applyDefaultValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:145
- public preSave() {@inheritdoc}$0->menu_link->preSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191
- public postSave($update) {@inheritdoc}$0->menu_link->postSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201
- public delete() {@inheritdoc}$0->menu_link->delete()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209
- public deleteRevision() {@inheritdoc}$0->menu_link->deleteRevision()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231
- public view($display_options = array()) {@inheritdoc}$0->menu_link->view()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
- public generateSampleItems($count = 1) {@inheritdoc}$0->menu_link->generateSampleItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->menu_link->defaultValuesForm()
/** * {@inheritdoc} */ 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->menu_link->defaultValuesFormValidate()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
- public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}$0->menu_link->equals()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
- public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}$0->menu_link->hasAffectingChanges()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449
- public getValue() {@inheritdoc}$0->menu_link->getValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42
- public getString() {@inheritdoc}$0->menu_link->getString()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61
- public get($index) {@inheritdoc}$0->menu_link->get()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69
- public set($index, $value) {@inheritdoc}$0->menu_link->set()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89
- public removeItem($index) {@inheritdoc}$0->menu_link->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->menu_link->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->menu_link->offsetExists()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:121
- public offsetUnset($offset): void {@inheritdoc}$0->menu_link->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->menu_link->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->menu_link->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->menu_link->appendItem()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97
- public getItemDefinition() {@inheritdoc}$0->menu_link->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->menu_link->getIterator()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:129
- public count(): int {@inheritdoc}$0->menu_link->count()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:137
- public isEmpty() {@inheritdoc}$0->menu_link->isEmpty()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113
- public filter($callback) {@inheritdoc}$0->menu_link->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->menu_link->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->menu_link
/** * 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->menu_link->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\token\MenuLinkFieldItemList()
/** * 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->menu_link->getPluginId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
- public getPluginDefinition() {@inheritdoc}$0->menu_link->getPluginDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
- public getDataDefinition() {@inheritdoc}$0->menu_link->getDataDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
- public validate() {@inheritdoc}$0->menu_link->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->menu_link->setContext()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
- public getName() {@inheritdoc}$0->menu_link->getName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
- public getRoot() {@inheritdoc}$0->menu_link->getRoot()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
- public getPropertyPath() {@inheritdoc}$0->menu_link->getPropertyPath()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
- public getParent() {@inheritdoc}$0->menu_link->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->menu_link->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->menu_link->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->menu_link->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>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:32
- 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 static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- 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
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklistediterator_to_array($0->menu_link, false)
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
- body -> Drupal\text\Plugin\Field\FieldType\TextFieldItemList#8565 (3)$0->body
- Field properties (3)
- Properties (9)
- Methods (69)
- Static methods (2)
- Iterator
- value -> UTF-8 string (3043) "<p>À l’origine, en 1969, M. Denis Gauvreau fondait ce chœur avec les Loisirs...$0->body->value
<p>À l’origine, en 1969, M. Denis Gauvreau fondait ce chœur avec les Loisirs Notre-Dame de Bonsecours : une trentaine de personnes en faisait partie. Le nombre de choristes a augmenté au fil des ans pour atteindre plus de 125 personnes avant la pandémie. Cependant, comme partout, la pandémie a fait mal mais la plupart des choristes sont revenus. Et on accueille chaque année de nouveaux choristes qui rajeunissent la chorale! </p><p>L’essor qu’a pris la chorale Les Mélodistes est dû en majeure partie à notre cheffe qui sait faire progresser les choristes dans le plaisir et le respect. Elle sait varier les répertoires, elle puise dans la musique populaire, la musique québécoise, les comédies musicales et ce, dans plusieurs langues : français, anglais, italien, espagnol, allemand. Elle est appuyée par une excellente pianiste qui nous accompagne chaque semaine, madame Sylvie Lemay. À elles deux, c’est vraiment une formidable équipe!</p><h3>Ses accomplissements :</h3><p>Impliquée dans la communauté de la ville de Brossard, la chorale Les Mélodistes a participé durant 16 ans au concert bénéfice de la Fondation d’entraide de Brossard.</p><p>Reconnue pour son répertoire varié et la qualité de sa préparation musicale, la chorale est régulièrement invitée par l’OSDL lors de ses prestations de Noël et de l’été. Avec l’OSDL, elle a fait partie du Chœur de la Neuvième symphonie de Beethoven présentée en avril 2015, à la salle Pratt & Whitney Canada et à Granby.</p><p>La chorale a accompagné l’OSDL et le groupe « JEANS’N CLASSICS » lors du Concert « Queen Symphonique » à la salle L’Étoile Banque Nationale, en février 2015.</p><p>Elle a participé au concert bénéfice de l’Oeuvre Léger à la « Maison Symphonique » ainsi qu’au concert bénéfice pour la Cocathédrale de Saint-Jean-Longueuil et du camp Garagona de Frelighsburg.</p><p>Durant 7 ans, elle a donné le concert d’ouverture de la série estivale «Les Mercredis en musique» pour la ville de Verdun.</p><p>La flexibilité de son répertoire lui a permis d’accompagner des artistes de renom, entre autres : Marie-Josée Lord, Marc Hervieux, Michel Louvain, Marie-Michèle Desrosiers, Giorgia Fumanti, Daniel Lavoie, Natalie Choquette et Bruno Pelletier.</p><p>En mai 2017, la chorale « Les Mélodistes » fut le chœur de l’OSDL dans la version concert de l’Opéra Carmen de Bizet, à la salle Pratt & Whitney Canada du Théâtre de la Ville de Longueuil.</p><p>Pour célébrer leur 50e en beauté, soixante choristes des Mélodistes ont participé au Festival International Choral en Provence et en Aveyron, du 3 au 14 juillet 2019, en chantant sur plusieurs scènes dans les villes, villages et châteaux de ces régions. </p><p>La chorale donne deux concerts par année : elle se produit au Théâtre Manuvie du quartier Dix-30 à Brossard lors de son concert de Noël en décembre et lors de son concert annuel en juin.</p>
- summary -> string (0) ""$0->body->summary
- format -> string (9) "full_html"$0->body->format
- value -> UTF-8 string (3043) "<p>À l’origine, en 1969, M. Denis Gauvreau fondait ce chœur avec les Loisirs...
- protected definition -> Drupal\field\Entity\FieldConfig#1634 (36)
- Properties (36)
- Methods (125)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (14) "node.page.body"
- protected status -> boolean true
- protected uuid -> string (36) "b05f7c01-155a-4bb4-b62a-b77b75e91fcf"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (1)
- default_config_hash => string (43) "rUop-8b6hvxxDYbv-KobTfNIBNbPY9qOPl8f6kBNSpw"
- protected trustedData -> boolean false
- protected dependencies -> array (2)
- config => array (2)
- 0 => string (23) "field.storage.node.body"
- 1 => string (14) "node.type.page"
- module => array (1)
- 0 => string (4) "text"
- protected isSyncing -> boolean false
- protected id -> string (14) "node.page.body"
- protected field_name -> string (4) "body"
- protected field_type -> string (17) "text_with_summary"
- protected entity_type -> string (4) "node"
- protected bundle -> string (4) "page"
- protected label -> string (5) "Corps"
- protected description -> string (0) ""
- protected settings -> array (3)
- display_summary => boolean false
- required_summary => boolean false
- allowed_formats => array (0)
- protected required -> boolean false
- protected translatable -> boolean true
- protected default_value -> array (0)
- protected default_value_callback -> string (0) ""
- protected fieldStorage -> Drupal\field\Entity\FieldStorageConfig#8567 (34)
- Properties (34)
- Methods (125)
- Static methods (15)
- Static properties (1)
- Class constants (2)
- protected entityTypeId -> string (20) "field_storage_config"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (9) "node.body"
- protected status -> boolean true
- protected uuid -> string (36) "55c47ffa-ec98-4e52-bd4e-eb9c26e35cea"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (1)
- default_config_hash => string (43) "EBUo7qOWqaiZaQ_RC9sLY5IoDKphS34v77VIHSACmVY"
- protected trustedData -> boolean false
- protected dependencies -> array (1)
- module => array (2)
- 0 => string (4) "node"
- 1 => string (4) "text"
- protected isSyncing -> boolean false
- protected id -> string (9) "node.body"
- protected field_name -> string (4) "body"
- protected entity_type -> string (4) "node"
- protected type -> string (17) "text_with_summary"
- protected module -> string (4) "text"
- protected settings -> array (0)
- protected cardinality -> integer 1
- protected translatable -> boolean true
- protected locked -> boolean false
- protected persist_with_no_fields -> boolean true
- public custom_storage -> boolean false
- protected indexes -> array (0)
- protected deleted -> boolean false
- protected schema -> null
- protected propertyDefinitions -> array (5)
- value => Drupal\Core\TypedData\DataDefinition#8627 (2)
- Properties (2)
- Methods (34)
- Static methods (2)
- protected definition -> array (3)
- type => string (6) "string"
- label => Drupal\Core\StringTranslation\TranslatableMarkup#8628 Depth Limit
- required => boolean true
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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
- format => Drupal\Core\TypedData\DataDefinition#8629 (2)
- Properties (2)
- Methods (34)
- Static methods (2)
- protected definition -> array (3)
- type => string (13) "filter_format"
- label => Drupal\Core\StringTranslation\TranslatableMarkup#8630 Depth Limit
- settings => array (1) Depth Limit
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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
- processed => Drupal\Core\TypedData\DataDefinition#8631 (2)
- Properties (2)
- Methods (34)
- Static methods (2)
- protected definition -> array (7)
- type => string (6) "string"
- label => Drupal\Core\StringTranslation\TranslatableMarkup#8632 Depth Limit
- description => Drupal\Core\StringTranslation\TranslatableMarkup#8633 Depth Limit
- computed => boolean true
- class => string (26) "\Drupal\text\TextProcessed"
- settings => array (1) Depth Limit
- internal => boolean false
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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
- summary => Drupal\Core\TypedData\DataDefinition#8634 (2)
- Properties (2)
- Methods (34)
- Static methods (2)
- protected definition -> array (2)
- type => string (6) "string"
- label => Drupal\Core\StringTranslation\TranslatableMarkup#8635 Depth Limit
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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
- summary_processed => Drupal\Core\TypedData\DataDefinition#8636 (2)
- Properties (2)
- Methods (34)
- Static methods (2)
- protected definition -> array (6)
- type => string (6) "string"
- label => Drupal\Core\StringTranslation\TranslatableMarkup#8637 Depth Limit
- description => Drupal\Core\StringTranslation\TranslatableMarkup#8638 Depth Limit
- computed => boolean true
- class => string (26) "\Drupal\text\TextProcessed"
- settings => array (1) Depth Limit
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.
/** * Constructs a FieldStorageConfig object. * * In most cases, Field entities are created via * FieldStorageConfig::create($values)), where $values is the same parameter * as in this constructor. * * @param array $values * An array of field properties, keyed by property name. Most array * elements will be used to set the corresponding properties on the class; * see the class property documentation for details. Some array elements * have special meanings and a few are required. Special elements are: * - name: required. As a temporary Backwards Compatibility layer right now, * a 'field_name' property can be accepted in place of 'id'. * - entity_type: required. * - type: required. * @param string $entity_type * (optional) The entity type on which the field should be created. * Defaults to "field_storage_config". */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:265
- public id() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:286
- public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:293
- 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/FieldStorageConfig.php:320
- protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.
/** * Prepares saving a new field definition. * * @param \Drupal\Core\Entity\EntityStorageInterface $storage * The entity storage. * * @throws \Drupal\Core\Field\FieldException * If the field definition is invalid. */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:350
- public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:376
- protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.
/** * Prepares saving an updated field definition. * * @param \Drupal\Core\Entity\EntityStorageInterface $storage * The entity storage. */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:397
- public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:421
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:479
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:505
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:512
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:519
- public getBundles() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:527
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:540
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:547
- public getTypeProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:554
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:561
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:568
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:582
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:601
- public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:609
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:617
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:624
- public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:632
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:640
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:647
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:654
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:661
- public setCardinality($cardinality) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:678
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:686
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:713
- public isLocked() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:721
- public setLocked($locked) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:728
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:736
- public hasData(): bool Determines whether a field has any data.
/** * Determines whether a field has any data. * * @return bool * TRUE if the field has data for any entity; FALSE otherwise. */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:746
- 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. */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:758
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:769
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:776
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:783
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:798
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:809
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:816
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:824
- protected getFieldItemClass() Helper to retrieve the field item class.
/** * Helper to retrieve the field item class. */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:831
- public isDeletable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:856
- public getIndexes() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:866
- public setIndexes(array $indexes) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:873
- 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
- protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * 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
- public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:478
- protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@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
- 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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@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}
/** * {@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
- protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * 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\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:435
- public static Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:464
- public static Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|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 $field_name * Name of the field. * * @return \Drupal\field\FieldStorageConfigInterface|null * The field config entity if one exists for the provided field name, * otherwise NULL. */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:849
- 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
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@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
- 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 static Drupal\field\Entity\FieldStorageConfig::$inDeletion :: boolean false
- public const Drupal\field\Entity\FieldStorageConfig::NAME_MAX_LENGTH :: integer 32
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#8566 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (28) "field_item:text_with_summary"
- settings => array (3)
- display_summary => boolean false
- required_summary => boolean false
- allowed_formats => array (0)
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected fieldDefinition -> Drupal\field\Entity\FieldConfig#1634 Recursion
- 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
- 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
- protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * 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
- protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@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
- protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * 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
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@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 $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 (4) "body"
- protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#8250 Blacklisted
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected list -> array (1)
- 0 => Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem#8643 (9)
- Properties (9)
- Methods (49)
- Static methods (24)
- Iterator
- protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#8566 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (28) "field_item:text_with_summary"
- settings => array (3)
- display_summary => boolean false
- required_summary => boolean false
- allowed_formats => array (0)
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected fieldDefinition -> Drupal\field\Entity\FieldConfig#1634 (36)
- Properties (36)
- Methods (125)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (14) "node.page.body"
- protected status -> boolean true
- protected uuid -> string (36) "b05f7c01-155a-4bb4-b62a-b77b75e91fcf"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (1)
- default_config_hash => string (43) "rUop-8b6hvxxDYbv-KobTfNIBNbPY9qOPl8f6kBNSpw"
- protected trustedData -> boolean false
- protected dependencies -> array (2)
- config => array (2) Depth Limit
- module => array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (14) "node.page.body"
- protected field_name -> string (4) "body"
- protected field_type -> string (17) "text_with_summary"
- protected entity_type -> string (4) "node"
- protected bundle -> string (4) "page"
- protected label -> string (5) "Corps"
- protected description -> string (0) ""
- protected settings -> array (3)
- display_summary => boolean false
- required_summary => boolean false
- allowed_formats => array (0)
- protected required -> boolean false
- protected translatable -> boolean true
- protected default_value -> array (0)
- protected default_value_callback -> string (0) ""
- protected fieldStorage -> Drupal\field\Entity\FieldStorageConfig#8567 (34)
- Properties (34)
- Methods (125)
- Static methods (15)
- Static properties (1)
- Class constants (2)
- protected entityTypeId -> string (20) "field_storage_config"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (1) Depth Limit
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (9) "node.body"
- protected status -> boolean true
- protected uuid -> string (36) "55c47ffa-ec98-4e52-bd4e-eb9c26e35cea"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (1) Depth Limit
- protected trustedData -> boolean false
- protected dependencies -> array (1) Depth Limit
- protected isSyncing -> boolean false
- protected id -> string (9) "node.body"
- protected field_name -> string (4) "body"
- protected entity_type -> string (4) "node"
- protected type -> string (17) "text_with_summary"
- protected module -> string (4) "text"
- protected settings -> array (0)
- protected cardinality -> integer 1
- protected translatable -> boolean true
- protected locked -> boolean false
- protected persist_with_no_fields -> boolean true
- public custom_storage -> boolean false
- protected indexes -> array (0)
- protected deleted -> boolean false
- protected schema -> null
- protected propertyDefinitions -> array (5) Depth Limit
- public __construct(array $values, $entity_type = 'field_storage_config') Constructs a FieldStorageConfig object.
/** * Constructs a FieldStorageConfig object. * * In most cases, Field entities are created via * FieldStorageConfig::create($values)), where $values is the same parameter * as in this constructor. * * @param array $values * An array of field properties, keyed by property name. Most array * elements will be used to set the corresponding properties on the class; * see the class property documentation for details. Some array elements * have special meanings and a few are required. Special elements are: * - name: required. As a temporary Backwards Compatibility layer right now, * a 'field_name' property can be accepted in place of 'id'. * - entity_type: required. * - type: required. * @param string $entity_type * (optional) The entity type on which the field should be created. * Defaults to "field_storage_config". */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:265
- public id() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:286
- public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:293
- 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/FieldStorageConfig.php:320
- protected preSaveNew(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving a new field definition.
/** * Prepares saving a new field definition. * * @param \Drupal\Core\Entity\EntityStorageInterface $storage * The entity storage. * * @throws \Drupal\Core\Field\FieldException * If the field definition is invalid. */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:350
- public calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:376
- protected preSaveUpdated(Drupal\Core\Entity\EntityStorageInterface $storage) Prepares saving an updated field definition.
/** * Prepares saving an updated field definition. * * @param \Drupal\Core\Entity\EntityStorageInterface $storage * The entity storage. */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:397
- public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:421
- public getSchema() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:479
- public hasCustomStorage() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:505
- public isBaseField() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:512
- public getColumns() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:519
- public getBundles() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:527
- public getName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:540
- public isDeleted() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:547
- public getTypeProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:554
- public getType() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:561
- public getSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:568
- public getSetting($setting_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:582
- public setSetting($setting_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:601
- public setSettings(array $settings) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:609
- public isTranslatable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:617
- public isRevisionable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:624
- public setTranslatable($translatable) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:632
- public getProvider() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:640
- public getLabel() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:647
- public getDescription() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:654
- public getCardinality() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:661
- public setCardinality($cardinality) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:678
- public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:686
- public isMultiple() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:713
- public isLocked() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:721
- public setLocked($locked) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:728
- public getTargetEntityTypeId() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:736
- public hasData(): bool Determines whether a field has any data.
/** * Determines whether a field has any data. * * @return bool * TRUE if the field has data for any entity; FALSE otherwise. */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:746
- 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. */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:758
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:769
- public getConstraint($constraint_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:776
- public getPropertyDefinition($name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:783
- public getPropertyDefinitions() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:798
- public getPropertyNames() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:809
- public getMainPropertyName() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:816
- public getUniqueStorageIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:824
- protected getFieldItemClass() Helper to retrieve the field item class.
/** * Helper to retrieve the field item class. */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:831
- public isDeletable() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:856
- public getIndexes() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:866
- public setIndexes(array $indexes) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:873
- 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
- protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * 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
- public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:478
- protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@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
- 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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@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}
/** * {@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
- protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * 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\FieldStorageConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_storages) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:435
- public static Drupal\field\Entity\FieldStorageConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:464
- public static Drupal\field\Entity\FieldStorageConfig::loadByName($entity_type_id, $field_name): \Drupal\field\FieldStorageConfigInterface|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 $field_name * Name of the field. * * @return \Drupal\field\FieldStorageConfigInterface|null * The field config entity if one exists for the provided field name, * otherwise NULL. */ Defined in <drupal>/core/modules/field/src/Entity/FieldStorageConfig.php:849
- 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
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@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
- 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 static Drupal\field\Entity\FieldStorageConfig::$inDeletion :: boolean false
- public const Drupal\field\Entity\FieldStorageConfig::NAME_MAX_LENGTH :: integer 32
- public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#8566 Recursion
- 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
- protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * 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
- protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@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
- protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * 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
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@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 $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 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
- protected name -> integer 0
- protected parent -> Drupal\text\Plugin\Field\FieldType\TextFieldItemList#8565 Recursion
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected values -> array (3)
- value => UTF-8 string (3043) "<p>À l’origine, en 1969, M. Denis Gauvreau fondait ce chœur avec les Loisirs...
<p>À l’origine, en 1969, M. Denis Gauvreau fondait ce chœur avec les Loisirs Notre-Dame de Bonsecours : une trentaine de personnes en faisait partie. Le nombre de choristes a augmenté au fil des ans pour atteindre plus de 125 personnes avant la pandémie. Cependant, comme partout, la pandémie a fait mal mais la plupart des choristes sont revenus. Et on accueille chaque année de nouveaux choristes qui rajeunissent la chorale! </p><p>L’essor qu’a pris la chorale Les Mélodistes est dû en majeure partie à notre cheffe qui sait faire progresser les choristes dans le plaisir et le respect. Elle sait varier les répertoires, elle puise dans la musique populaire, la musique québécoise, les comédies musicales et ce, dans plusieurs langues : français, anglais, italien, espagnol, allemand. Elle est appuyée par une excellente pianiste qui nous accompagne chaque semaine, madame Sylvie Lemay. À elles deux, c’est vraiment une formidable équipe!</p><h3>Ses accomplissements :</h3><p>Impliquée dans la communauté de la ville de Brossard, la chorale Les Mélodistes a participé durant 16 ans au concert bénéfice de la Fondation d’entraide de Brossard.</p><p>Reconnue pour son répertoire varié et la qualité de sa préparation musicale, la chorale est régulièrement invitée par l’OSDL lors de ses prestations de Noël et de l’été. Avec l’OSDL, elle a fait partie du Chœur de la Neuvième symphonie de Beethoven présentée en avril 2015, à la salle Pratt & Whitney Canada et à Granby.</p><p>La chorale a accompagné l’OSDL et le groupe « JEANS’N CLASSICS » lors du Concert « Queen Symphonique » à la salle L’Étoile Banque Nationale, en février 2015.</p><p>Elle a participé au concert bénéfice de l’Oeuvre Léger à la « Maison Symphonique » ainsi qu’au concert bénéfice pour la Cocathédrale de Saint-Jean-Longueuil et du camp Garagona de Frelighsburg.</p><p>Durant 7 ans, elle a donné le concert d’ouverture de la série estivale «Les Mercredis en musique» pour la ville de Verdun.</p><p>La flexibilité de son répertoire lui a permis d’accompagner des artistes de renom, entre autres : Marie-Josée Lord, Marc Hervieux, Michel Louvain, Marie-Michèle Desrosiers, Giorgia Fumanti, Daniel Lavoie, Natalie Choquette et Bruno Pelletier.</p><p>En mai 2017, la chorale « Les Mélodistes » fut le chœur de l’OSDL dans la version concert de l’Opéra Carmen de Bizet, à la salle Pratt & Whitney Canada du Théâtre de la Ville de Longueuil.</p><p>Pour célébrer leur 50e en beauté, soixante choristes des Mélodistes ont participé au Festival International Choral en Provence et en Aveyron, du 3 au 14 juillet 2019, en chantant sur plusieurs scènes dans les villes, villages et châteaux de ces régions. </p><p>La chorale donne deux concerts par année : elle se produit au Théâtre Manuvie du quartier Dix-30 à Brossard lors de son concert de Noël en décembre et lors de son concert annuel en juin.</p>
- summary => string (0) ""
- format => string (9) "full_html"
- protected properties -> array (2)
- processed => Drupal\text\TextProcessed#8644 (8)
- Properties (8)
- Methods (28)
- Static methods (1)
- protected definition -> Drupal\Core\TypedData\DataDefinition#8631 (2)
- Properties (2)
- Methods (34)
- Static methods (2)
- protected definition -> array (7) Depth Limit
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 name -> string (9) "processed"
- protected parent -> Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem#8643 Recursion
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected processed -> null
- public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:31
- public getValue() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:43
- public setValue($value, $notify = true) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:73
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:84
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:92
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:100
- protected getRenderer(): \Drupal\Core\Render\RendererInterface Returns the renderer service.
/** * Returns the renderer service. * * @return \Drupal\Core\Render\RendererInterface * The renderer service. */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:111
- 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\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- summary_processed => Drupal\text\TextProcessed#8645 (8)
- Properties (8)
- Methods (28)
- Static methods (1)
- protected definition -> Drupal\Core\TypedData\DataDefinition#8636 (2)
- Properties (2)
- Methods (34)
- Static methods (2)
- protected definition -> array (6) Depth Limit
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 name -> string (17) "summary_processed"
- protected parent -> Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem#8643 Recursion
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected processed -> null
- public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:31
- public getValue() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:43
- public setValue($value, $notify = true) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:73
- public getCacheTags() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:84
- public getCacheContexts() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:92
- public getCacheMaxAge() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:100
- protected getRenderer(): \Drupal\Core\Render\RendererInterface Returns the renderer service.
/** * Returns the renderer service. * * @return \Drupal\Core\Render\RendererInterface * The renderer service. */ Defined in <drupal>/core/modules/text/src/TextProcessed.php:111
- 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\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- public isEmpty() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:87
- public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:95
- public getConstraints() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:119
- public applyDefaultValue($notify = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\text\Plugin\Field\FieldType\TextItemBase Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:99
- public onChange($property_name, $notify = true) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\text\Plugin\Field\FieldType\TextItemBase Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:116
- public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}
/** * {@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
- protected writePropertyValue($property_name, $value) {@inheritdoc}
/** * {@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 getValue() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:56
- public getString() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:104
- 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:116
- 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:131
- 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:163
- public toArray() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:176
- public getIterator(): ArrayIterator {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\Plugin\DataType\Map Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:187
- 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:214
- 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 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\text\Plugin\Field\FieldType\TextWithSummaryItem::defaultFieldSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:33
- public static Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:43
- public static Drupal\text\Plugin\Field\FieldType\TextWithSummaryItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextWithSummaryItem.php:62
- public static Drupal\text\Plugin\Field\FieldType\TextItemBase::validateAllowedFormats(array &$element, Drupal\Core\Form\FormStateInterface $form_state) Render API callback: Processes the allowed formats value.
/** * Render API callback: Processes the allowed formats value. * * Ensure the element's value is an indexed array of selected format IDs. * This function is assigned as an #element_validate callback. * * @see static::fieldSettingsForm() */ Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:51
- public static Drupal\text\Plugin\Field\FieldType\TextItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:59
- public static Drupal\text\Plugin\Field\FieldType\TextItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:131
- 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::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::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::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
- public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- public static Drupal\text\Plugin\Field\FieldType\TextItemBase::defaultFieldSettings() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:20
- public static Drupal\text\Plugin\Field\FieldType\TextItemBase::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextItemBase.php:76
- 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
- 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::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::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275
- 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
- Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted
- protected langcode -> string (2) "fr"
- public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->body->defaultValuesFormValidate()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextFieldItemList.php:16
- protected createItem($offset = 0, $value = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44
- public getEntity() {@inheritdoc}$0->body->getEntity()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51
- public setLangcode($langcode) {@inheritdoc}$0->body->setLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60
- public getLangcode() {@inheritdoc}$0->body->getLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67
- public getFieldDefinition() {@inheritdoc}$0->body->getFieldDefinition()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74
- public getSettings() {@inheritdoc}$0->body->getSettings()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81
- public getSetting($setting_name) {@inheritdoc}$0->body->getSetting()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88
- public filterEmptyItems() {@inheritdoc}$0->body->filterEmptyItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95
- public setValue($values, $notify = true) {@inheritdoc}$0->body->setValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105
- public __get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117
- public __set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127
- public __isset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137
- public __unset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0->body->access()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156
- public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}$0->body->defaultAccess()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164
- public applyDefaultValue($notify = true) {@inheritdoc}$0->body->applyDefaultValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172
- public preSave() {@inheritdoc}$0->body->preSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191
- public postSave($update) {@inheritdoc}$0->body->postSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201
- public delete() {@inheritdoc}$0->body->delete()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209
- public deleteRevision() {@inheritdoc}$0->body->deleteRevision()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231
- public view($display_options = array()) {@inheritdoc}$0->body->view()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
- public generateSampleItems($count = 1) {@inheritdoc}$0->body->generateSampleItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253
- public getConstraints() {@inheritdoc}$0->body->getConstraints()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->body->defaultValuesForm()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290
- public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->body->defaultValuesFormSubmit()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
- public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}$0->body->equals()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
- public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}$0->body->hasAffectingChanges()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449
- public getValue() {@inheritdoc}$0->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body->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->body
/** * 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->body->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\text\Plugin\Field\FieldType\TextFieldItemList()
/** * 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->body->getPluginId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
- public getPluginDefinition() {@inheritdoc}$0->body->getPluginDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
- public getDataDefinition() {@inheritdoc}$0->body->getDataDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
- public validate() {@inheritdoc}$0->body->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->body->setContext()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
- public getName() {@inheritdoc}$0->body->getName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
- public getRoot() {@inheritdoc}$0->body->getRoot()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
- public getPropertyPath() {@inheritdoc}$0->body->getPropertyPath()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
- public getParent() {@inheritdoc}$0->body->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->body->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->body->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->body->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 defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
- 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 static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklistediterator_to_array($0->body, false)
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
- field_image -> Drupal\file\Plugin\Field\FieldType\FileFieldItemList#8647 (0)$0->field_image
- No values
- Properties (9)
- Methods (70)
- Static methods (3)
- Iterator
- No values uninitialized
- protected definition -> Drupal\field\Entity\FieldConfig#1632 (36)
- Properties (36)
- Methods (125)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (21) "node.page.field_image"
- protected status -> boolean true
- protected uuid -> string (36) "79992ada-6d5e-4e18-882b-5df759b21079"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (1)
- filefield_paths => array (6)
- enabled => boolean true
- file_path => array (2)
- value => string (12) "images/pages"
- options => array (3)
- slashes => boolean false
- pathauto => boolean false
- transliterate => boolean false
- file_name => array (2)
- value => string (59) "[file:ffp-name-only-original].[file:ffp-extension-original]"
- options => array (3)
- slashes => boolean false
- pathauto => boolean false
- transliterate => boolean false
- redirect => boolean false
- retroactive_update => boolean false
- active_updating => boolean false
- protected _core -> array (0)
- protected trustedData -> boolean false
- protected dependencies -> array (2)
- Table (2)
- Contents (2)
0 1 config field.storage.node.field_image node.type.page module filefield_paths image - config => array (2)
- 0 => string (30) "field.storage.node.field_image"
- 1 => string (14) "node.type.page"
- module => array (2)
- 0 => string (15) "filefield_paths"
- 1 => string (5) "image"
- protected isSyncing -> boolean false
- protected id -> string (21) "node.page.field_image"
- protected field_name -> string (11) "field_image"
- protected field_type -> string (5) "image"
- protected entity_type -> string (4) "node"
- protected bundle -> string (4) "page"
- protected label -> string (5) "Image"
- protected description -> UTF-8 string (35) "Image à mettre en haut de la page."
- protected settings -> array (12)
- handler => string (12) "default:file"
- handler_settings => array (0)
- file_directory => string (31) "[date:custom:Y]-[date:custom:m]"
- file_extensions => string (16) "png gif jpg jpeg"
- max_filesize => string (0) ""
- max_resolution => string (0) ""
- min_resolution => string (0) ""
- alt_field => boolean false
- alt_field_required => boolean true
- title_field => boolean false
- title_field_required => boolean false
- default_image => array (5)
- uuid => string (0) ""
- alt => string (0) ""
- title => string (0) ""
- width => null
- height => null
- 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
- protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * 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
- protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@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
- protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * 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
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@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 $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 (11) "field_image"
- protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#8250 Blacklisted
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected list -> array (0)
- protected langcode -> string (2) "fr"
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->field_image->defaultValuesForm()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:16
- public postSave($update) {@inheritdoc}$0->field_image->postSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:21
- public delete() {@inheritdoc}$0->field_image->delete()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:79
- public deleteRevision() {@inheritdoc}$0->field_image->deleteRevision()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php:94
- public getConstraints() {@inheritdoc}$0->field_image->getConstraints()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\EntityReferenceFieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:16
- public referencedEntities() {@inheritdoc}$0->field_image->referencedEntities()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\EntityReferenceFieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:26
- public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->field_image->defaultValuesFormSubmit()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\EntityReferenceFieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:107
- protected createItem($offset = 0, $value = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44
- public getEntity() {@inheritdoc}$0->field_image->getEntity()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51
- public setLangcode($langcode) {@inheritdoc}$0->field_image->setLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60
- public getLangcode() {@inheritdoc}$0->field_image->getLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67
- public getFieldDefinition() {@inheritdoc}$0->field_image->getFieldDefinition()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74
- public getSettings() {@inheritdoc}$0->field_image->getSettings()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81
- public getSetting($setting_name) {@inheritdoc}$0->field_image->getSetting()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88
- public filterEmptyItems() {@inheritdoc}$0->field_image->filterEmptyItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95
- public setValue($values, $notify = true) {@inheritdoc}$0->field_image->setValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105
- public __get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117
- public __set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127
- public __isset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137
- public __unset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0->field_image->access()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156
- public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}$0->field_image->defaultAccess()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164
- public applyDefaultValue($notify = true) {@inheritdoc}$0->field_image->applyDefaultValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172
- public preSave() {@inheritdoc}$0->field_image->preSave()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231
- public view($display_options = array()) {@inheritdoc}$0->field_image->view()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
- public generateSampleItems($count = 1) {@inheritdoc}$0->field_image->generateSampleItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253
- public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->field_image->defaultValuesFormValidate()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
- public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}$0->field_image->equals()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
- public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}$0->field_image->hasAffectingChanges()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449
- public getValue() {@inheritdoc}$0->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image->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->field_image
/** * 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->field_image->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->field_image->getPluginId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
- public getPluginDefinition() {@inheritdoc}$0->field_image->getPluginDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
- public getDataDefinition() {@inheritdoc}$0->field_image->getDataDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
- public validate() {@inheritdoc}$0->field_image->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->field_image->setContext()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
- public getName() {@inheritdoc}$0->field_image->getName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
- public getRoot() {@inheritdoc}$0->field_image->getRoot()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
- public getPropertyPath() {@inheritdoc}$0->field_image->getPropertyPath()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
- public getParent() {@inheritdoc}$0->field_image->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->field_image->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->field_image->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->field_image->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 defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}
- 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 static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- 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
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklistediterator_to_array($0->field_image, false)
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
- field_ordre -> Drupal\Core\Field\FieldItemList#8649 (0)$0->field_ordre
- No values
- Properties (9)
- Methods (69)
- Static methods (2)
- Iterator
- No values uninitialized
- protected definition -> Drupal\field\Entity\FieldConfig#1635 (36)
- Properties (36)
- Methods (125)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (21) "node.page.field_ordre"
- protected status -> boolean true
- protected uuid -> string (36) "a3ac8315-3a4c-4c73-8566-1b98d49aa0ea"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- protected dependencies -> array (2)
- config => array (2)
- 0 => string (30) "field.storage.node.field_ordre"
- 1 => string (14) "node.type.page"
- module => array (1)
- 0 => string (6) "weight"
- protected isSyncing -> boolean false
- protected id -> string (21) "node.page.field_ordre"
- protected field_name -> string (11) "field_ordre"
- protected field_type -> string (6) "weight"
- protected entity_type -> string (4) "node"
- protected bundle -> string (4) "page"
- protected label -> string (19) "Ordre dans la liste"
- protected description -> UTF-8 string (124) "Ordre d'affichage dans la liste. Modifié automatiquement par un cliquer / dé...
Ordre d'affichage dans la liste. Modifié automatiquement par un cliquer / déplacer / relâcher dans liste en mode gestion.
- protected settings -> array (1)
- range => string (2) "20"
- protected required -> boolean false
- protected translatable -> boolean false
- protected default_value -> array (1)
- 0 => array (1)
- value => string (1) "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
- protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * 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
- protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@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
- protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * 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
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@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 $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 (11) "field_ordre"
- protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#8250 Blacklisted
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected list -> array (0)
- protected langcode -> string (2) "fr"
- protected createItem($offset = 0, $value = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44
- public getEntity() {@inheritdoc}$0->field_ordre->getEntity()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51
- public setLangcode($langcode) {@inheritdoc}$0->field_ordre->setLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60
- public getLangcode() {@inheritdoc}$0->field_ordre->getLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67
- public getFieldDefinition() {@inheritdoc}$0->field_ordre->getFieldDefinition()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74
- public getSettings() {@inheritdoc}$0->field_ordre->getSettings()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81
- public getSetting($setting_name) {@inheritdoc}$0->field_ordre->getSetting()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88
- public filterEmptyItems() {@inheritdoc}$0->field_ordre->filterEmptyItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95
- public setValue($values, $notify = true) {@inheritdoc}$0->field_ordre->setValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105
- public __get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117
- public __set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127
- public __isset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137
- public __unset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0->field_ordre->access()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156
- public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}$0->field_ordre->defaultAccess()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164
- public applyDefaultValue($notify = true) {@inheritdoc}$0->field_ordre->applyDefaultValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172
- public preSave() {@inheritdoc}$0->field_ordre->preSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191
- public postSave($update) {@inheritdoc}$0->field_ordre->postSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201
- public delete() {@inheritdoc}$0->field_ordre->delete()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209
- public deleteRevision() {@inheritdoc}$0->field_ordre->deleteRevision()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231
- public view($display_options = array()) {@inheritdoc}$0->field_ordre->view()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
- public generateSampleItems($count = 1) {@inheritdoc}$0->field_ordre->generateSampleItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253
- public getConstraints() {@inheritdoc}$0->field_ordre->getConstraints()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->field_ordre->defaultValuesForm()
/** * {@inheritdoc} */ 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->field_ordre->defaultValuesFormValidate()
/** * {@inheritdoc} */ 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->field_ordre->defaultValuesFormSubmit()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
- public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}$0->field_ordre->equals()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
- public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}$0->field_ordre->hasAffectingChanges()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449
- public getValue() {@inheritdoc}$0->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre
/** * 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->field_ordre->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\FieldItemList()
/** * 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->field_ordre->getPluginId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
- public getPluginDefinition() {@inheritdoc}$0->field_ordre->getPluginDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
- public getDataDefinition() {@inheritdoc}$0->field_ordre->getDataDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
- public validate() {@inheritdoc}$0->field_ordre->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->field_ordre->setContext()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
- public getName() {@inheritdoc}$0->field_ordre->getName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
- public getRoot() {@inheritdoc}$0->field_ordre->getRoot()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
- public getPropertyPath() {@inheritdoc}$0->field_ordre->getPropertyPath()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
- public getParent() {@inheritdoc}$0->field_ordre->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->field_ordre->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->field_ordre->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->field_ordre->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
- public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklistediterator_to_array($0->field_ordre, false)
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
- field_type_page -> Drupal\Core\Field\EntityReferenceFieldItemList#8651 (0)$0->field_type_page
- No values
- Properties (9)
- Methods (70)
- Static methods (3)
- Iterator
- No values uninitialized
- protected definition -> Drupal\field\Entity\FieldConfig#1637 (36)
- Properties (36)
- Methods (125)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (25) "node.page.field_type_page"
- protected status -> boolean true
- protected uuid -> string (36) "9bdce793-1f19-4771-8aeb-85159148a762"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- protected dependencies -> array (1)
- config => array (3)
- 0 => string (34) "field.storage.node.field_type_page"
- 1 => string (14) "node.type.page"
- 2 => string (29) "taxonomy.vocabulary.type_page"
- protected isSyncing -> boolean false
- protected id -> string (25) "node.page.field_type_page"
- protected field_name -> string (15) "field_type_page"
- protected field_type -> string (16) "entity_reference"
- protected entity_type -> string (4) "node"
- protected bundle -> string (4) "page"
- protected label -> string (12) "Type de page"
- protected description -> string (0) ""
- protected settings -> array (2)
- handler => string (21) "default:taxonomy_term"
- handler_settings => array (4)
- target_bundles => array (1)
- type_page => string (9) "type_page"
- sort => array (2)
- field => string (4) "name"
- direction => string (3) "asc"
- auto_create => boolean false
- auto_create_bundle => string (0) ""
- protected required -> boolean true
- 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
- protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * 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
- protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@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
- protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * 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
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@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 $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 (15) "field_type_page"
- protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#8250 Blacklisted
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected stringTranslation -> null
- protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1183 Blacklisted
- protected list -> array (0)
- protected langcode -> string (2) "fr"
- public getConstraints() {@inheritdoc}$0->field_type_page->getConstraints()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\EntityReferenceFieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:16
- public referencedEntities() {@inheritdoc}$0->field_type_page->referencedEntities()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\EntityReferenceFieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:26
- public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->field_type_page->defaultValuesFormSubmit()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\EntityReferenceFieldItemList Defined in <drupal>/core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php:107
- protected createItem($offset = 0, $value = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44
- public getEntity() {@inheritdoc}$0->field_type_page->getEntity()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51
- public setLangcode($langcode) {@inheritdoc}$0->field_type_page->setLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60
- public getLangcode() {@inheritdoc}$0->field_type_page->getLangcode()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67
- public getFieldDefinition() {@inheritdoc}$0->field_type_page->getFieldDefinition()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74
- public getSettings() {@inheritdoc}$0->field_type_page->getSettings()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81
- public getSetting($setting_name) {@inheritdoc}$0->field_type_page->getSetting()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88
- public filterEmptyItems() {@inheritdoc}$0->field_type_page->filterEmptyItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95
- public setValue($values, $notify = true) {@inheritdoc}$0->field_type_page->setValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105
- public __get($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117
- public __set($property_name, $value) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127
- public __isset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137
- public __unset($property_name) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0->field_type_page->access()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156
- public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc}$0->field_type_page->defaultAccess()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164
- public applyDefaultValue($notify = true) {@inheritdoc}$0->field_type_page->applyDefaultValue()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172
- public preSave() {@inheritdoc}$0->field_type_page->preSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191
- public postSave($update) {@inheritdoc}$0->field_type_page->postSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201
- public delete() {@inheritdoc}$0->field_type_page->delete()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209
- public deleteRevision() {@inheritdoc}$0->field_type_page->deleteRevision()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231
- public view($display_options = array()) {@inheritdoc}$0->field_type_page->view()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245
- public generateSampleItems($count = 1) {@inheritdoc}$0->field_type_page->generateSampleItems()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253
- public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}$0->field_type_page->defaultValuesForm()
/** * {@inheritdoc} */ 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->field_type_page->defaultValuesFormValidate()
/** * {@inheritdoc} */ 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. */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352
- public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc}$0->field_type_page->equals()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403
- public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc}$0->field_type_page->hasAffectingChanges()
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449
- public getValue() {@inheritdoc}$0->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page
/** * 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->field_type_page->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
- public getPluginId() {@inheritdoc}$0->field_type_page->getPluginId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73
- public getPluginDefinition() {@inheritdoc}$0->field_type_page->getPluginDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80
- public getDataDefinition() {@inheritdoc}$0->field_type_page->getDataDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87
- public validate() {@inheritdoc}$0->field_type_page->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->field_type_page->setContext()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147
- public getName() {@inheritdoc}$0->field_type_page->getName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155
- public getRoot() {@inheritdoc}$0->field_type_page->getRoot()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162
- public getPropertyPath() {@inheritdoc}$0->field_type_page->getPropertyPath()
/** * {@inheritdoc} */ Inherited from Drupal\Core\TypedData\TypedData Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173
- public getParent() {@inheritdoc}$0->field_type_page->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->field_type_page->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->field_type_page->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->field_type_page->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 getConstraints() {@inheritdoc}
- 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 static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
- 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
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklistediterator_to_array($0->field_type_page, false)
- ⇄Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
- nid -> string (3) "134"
- protected entityTypeId -> string (4) "node"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (0)
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected values -> array (20)
- nid => array (1)
- x-default => string (3) "134"
- vid => array (1)
- x-default => string (3) "136"
- type => array (1)
- x-default => string (4) "page"
- uuid => array (1)
- x-default => string (36) "8793de7f-ec8a-4d6f-99c8-d7fa0637c4e5"
- langcode => array (1)
- x-default => string (2) "fr"
- revision_default => array (1)
- x-default => string (1) "1"
- revision_uid => array (1)
- x-default => string (1) "1"
- revision_timestamp => array (1)
- x-default => string (10) "1738020409"
2025-01-27T23:26:49+00:00
- revision_log => array (1)
- x-default => null
- isDefaultRevision => array (1)
- x-default => string (1) "1"
- title => array (1)
- x-default => UTF-8 string (38) "Les Mélodistes et leur belle histoire"
- uid => array (1)
- x-default => string (1) "1"
- status => array (1)
- x-default => string (1) "1"
- created => array (1)
- x-default => string (10) "1738020409"
2025-01-27T23:26:49+00:00
- changed => array (1)
- x-default => string (10) "1738594765"
2025-02-03T14:59:25+00:00
- promote => array (1)
- x-default => string (1) "0"
- sticky => array (1)
- x-default => string (1) "0"
- revision_translation_affected => array (1)
- x-default => string (1) "1"
- default_langcode => array (1)
- x-default => string (1) "1"
- body => array (1)
- x-default => array (1)
- 0 => array (3)
- value => UTF-8 string (3043) "<p>À l’origine, en 1969, M. Denis Gauvreau fondait ce chœur avec les Loisirs...
<p>À l’origine, en 1969, M. Denis Gauvreau fondait ce chœur avec les Loisirs Notre-Dame de Bonsecours : une trentaine de personnes en faisait partie. Le nombre de choristes a augmenté au fil des ans pour atteindre plus de 125 personnes avant la pandémie. Cependant, comme partout, la pandémie a fait mal mais la plupart des choristes sont revenus. Et on accueille chaque année de nouveaux choristes qui rajeunissent la chorale! </p><p>L’essor qu’a pris la chorale Les Mélodistes est dû en majeure partie à notre cheffe qui sait faire progresser les choristes dans le plaisir et le respect. Elle sait varier les répertoires, elle puise dans la musique populaire, la musique québécoise, les comédies musicales et ce, dans plusieurs langues : français, anglais, italien, espagnol, allemand. Elle est appuyée par une excellente pianiste qui nous accompagne chaque semaine, madame Sylvie Lemay. À elles deux, c’est vraiment une formidable équipe!</p><h3>Ses accomplissements :</h3><p>Impliquée dans la communauté de la ville de Brossard, la chorale Les Mélodistes a participé durant 16 ans au concert bénéfice de la Fondation d’entraide de Brossard.</p><p>Reconnue pour son répertoire varié et la qualité de sa préparation musicale, la chorale est régulièrement invitée par l’OSDL lors de ses prestations de Noël et de l’été. Avec l’OSDL, elle a fait partie du Chœur de la Neuvième symphonie de Beethoven présentée en avril 2015, à la salle Pratt & Whitney Canada et à Granby.</p><p>La chorale a accompagné l’OSDL et le groupe « JEANS’N CLASSICS » lors du Concert « Queen Symphonique » à la salle L’Étoile Banque Nationale, en février 2015.</p><p>Elle a participé au concert bénéfice de l’Oeuvre Léger à la « Maison Symphonique » ainsi qu’au concert bénéfice pour la Cocathédrale de Saint-Jean-Longueuil et du camp Garagona de Frelighsburg.</p><p>Durant 7 ans, elle a donné le concert d’ouverture de la série estivale «Les Mercredis en musique» pour la ville de Verdun.</p><p>La flexibilité de son répertoire lui a permis d’accompagner des artistes de renom, entre autres : Marie-Josée Lord, Marc Hervieux, Michel Louvain, Marie-Michèle Desrosiers, Giorgia Fumanti, Daniel Lavoie, Natalie Choquette et Bruno Pelletier.</p><p>En mai 2017, la chorale « Les Mélodistes » fut le chœur de l’OSDL dans la version concert de l’Opéra Carmen de Bizet, à la salle Pratt & Whitney Canada du Théâtre de la Ville de Longueuil.</p><p>Pour célébrer leur 50e en beauté, soixante choristes des Mélodistes ont participé au Festival International Choral en Provence et en Aveyron, du 3 au 14 juillet 2019, en chantant sur plusieurs scènes dans les villes, villages et châteaux de ces régions. </p><p>La chorale donne deux concerts par année : elle se produit au Théâtre Manuvie du quartier Dix-30 à Brossard lors de son concert de Noël en décembre et lors de son concert annuel en juin.</p>
- summary => string (0) ""
- format => string (9) "full_html"
- protected fields -> array (0)
- protected fieldDefinitions -> array (25)
- nid => Drupal\Core\Field\BaseFieldDefinition#316 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (6)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1547 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (2) "ID"
- 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 (16) "Identifiant (ID)"
- read-only => boolean true
- provider => string (4) "node"
- field_name => string (3) "nid"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1543 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (18) "field_item:integer"
- settings => array (6)
- unsigned => boolean true
- size => string (6) "normal"
- min => string (0) ""
- max => string (0) ""
- prefix => string (0) ""
- suffix => string (0) ""
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#316 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- uuid => Drupal\Core\Field\BaseFieldDefinition#1549 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (6)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1552 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (4) "UUID"
- 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 (35) "Identifiant universel unique (UUID)"
- read-only => boolean true
- provider => string (4) "node"
- field_name => string (4) "uuid"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1548 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (15) "field_item:uuid"
- settings => array (3)
- max_length => integer 128
- is_ascii => boolean true
- case_sensitive => boolean false
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1549 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- vid => Drupal\Core\Field\BaseFieldDefinition#1553 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (6)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1554 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (11) "Revision ID"
- 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 (27) "Identifiant (ID) de version"
- read-only => boolean true
- provider => string (4) "node"
- field_name => string (3) "vid"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1555 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (18) "field_item:integer"
- settings => array (6)
- unsigned => boolean true
- size => string (6) "normal"
- min => string (0) ""
- max => string (0) ""
- prefix => string (0) ""
- suffix => string (0) ""
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1553 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- langcode => Drupal\Core\Field\BaseFieldDefinition#1556 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (8)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1557 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (8) "Language"
- 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 (6) "Langue"
- display => array (2)
- Table (2)
- Contents (2)
options configurable view array (1) true form array (2) true - view => array (2)
- options => array (1)
- region => string (6) "hidden"
- configurable => boolean true
- form => array (2)
- options => array (2)
- type => string (15) "language_select"
- weight => integer 2
- configurable => boolean true
- revisionable => boolean true
- translatable => boolean true
- provider => string (4) "node"
- field_name => string (8) "langcode"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1558 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (19) "field_item:language"
- settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1556 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- type => Drupal\Core\Field\BaseFieldDefinition#1559 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7)
- label => string (15) "Type de contenu"
- required => boolean true
- read-only => boolean true
- provider => string (4) "node"
- field_name => string (4) "type"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1560 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (27) "field_item:entity_reference"
- settings => array (3)
- target_type => string (9) "node_type"
- handler => string (7) "default"
- handler_settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1559 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- revision_timestamp => Drupal\Core\Field\BaseFieldDefinition#1561 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1562 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (20) "Revision create time"
- 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 UTF-8 string (32) "Heure de création de la version"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1563 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (47) "The time that the current revision 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 UTF-8 string (56) "La date à laquelle la version actuelle a été créée."
- revisionable => boolean true
- provider => string (4) "node"
- field_name => string (18) "revision_timestamp"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1564 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (18) "field_item:created"
- settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1561 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- revision_uid => Drupal\Core\Field\BaseFieldDefinition#1565 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (7)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1566 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (13) "Revision 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
- label UTF-8 string (38) "Utilisateur à l'origine de la version"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1567 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (50) "The user ID of the author of the current revision."
- 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 (66) "L'identifiant (ID) utilisateur de l'auteur de la version actuelle."
- revisionable => boolean true
- provider => string (4) "node"
- field_name => string (12) "revision_uid"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1568 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (27) "field_item:entity_reference"
- settings => array (3)
- target_type => string (4) "user"
- handler => string (7) "default"
- handler_settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1565 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- revision_log => Drupal\Core\Field\BaseFieldDefinition#1569 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (9)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1570 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (20) "Revision log message"
- 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 (29) "Message du journal de version"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1571 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (43) "Briefly describe the changes you have made."
- 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 UTF-8 string (50) "Décrire brièvement les modifications apportées."
- revisionable => boolean true
- default_value => array (1)
- 0 => array (1)
- value => string (0) ""
- display => array (1)
- form => array (1)
- options => array (3)
- type => string (15) "string_textarea"
- weight => integer 25
- settings => array (1) Depth Limit
- provider => string (4) "node"
- field_name => string (12) "revision_log"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1572 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (22) "field_item:string_long"
- settings => array (1)
- case_sensitive => boolean false
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1569 Recursion
- 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
- protected type -> string (11) "string_long"
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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#1573 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (9)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1574 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (9) "Published"
- 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 UTF-8 string (7) "Publié"
- revisionable => boolean true
- translatable => boolean true
- default_value => array (1)
- 0 => array (1)
- value => boolean true
- display => array (1)
- form => array (2)
- options => array (3)
- type => string (16) "boolean_checkbox"
- settings => array (1) Depth Limit
- weight => integer 120
- configurable => boolean true
- provider => string (4) "node"
- field_name => string (6) "status"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1575 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (18) "field_item:boolean"
- settings => array (2)
- on_label => Drupal\Core\StringTranslation\TranslatableMarkup#1576 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (2) "On"
- 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
- on_label string (2) "On"
- off_label => Drupal\Core\StringTranslation\TranslatableMarkup#1577 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (3) "Off"
- 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
- off_label string (3) "Off"
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1573 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- uid => Drupal\Core\Field\BaseFieldDefinition#1578 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (10)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1579 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (11) "Authored by"
- 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 UTF-8 string (10) "Écrit par"
- translatable => boolean true
- default_value_callback => string (46) "Drupal\node\Entity\Node::getDefaultEntityOwner"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1580 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (35) "The username of the content author."
- 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 (44) "Le nom d'utilisateur de l'auteur du contenu."
- revisionable => boolean true
- display => array (2)
- view => array (1)
- options => array (3)
- label => string (6) "hidden"
- type => string (6) "author"
- weight => integer 0
- form => array (2)
- options => array (3)
- type => string (29) "entity_reference_autocomplete"
- weight => integer 5
- settings => array (3) Depth Limit
- configurable => boolean true
- provider => string (4) "node"
- field_name => string (3) "uid"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1581 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (27) "field_item:entity_reference"
- settings => array (3)
- target_type => string (4) "user"
- handler => string (7) "default"
- handler_settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1578 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- title => Drupal\Core\Field\BaseFieldDefinition#1582 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (9)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1583 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (5) "Title"
- 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 (5) "Titre"
- required => boolean true
- translatable => boolean true
- revisionable => boolean true
- display => array (2)
- view => array (1)
- options => array (3)
- label => string (6) "hidden"
- type => string (6) "string"
- weight => integer -5
- form => array (2)
- options => array (2)
- type => string (16) "string_textfield"
- weight => integer -5
- configurable => boolean true
- provider => string (4) "node"
- field_name => string (5) "title"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1584 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (17) "field_item:string"
- settings => array (3)
- max_length => integer 255
- is_ascii => boolean false
- case_sensitive => boolean false
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1582 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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#1585 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (9)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1586 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (11) "Authored on"
- 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 UTF-8 string (9) "Écrit le"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1587 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (47) "The date and time that the content 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 UTF-8 string (56) "La date et l'heure auxquelles le contenu a été créé."
- revisionable => boolean true
- translatable => boolean true
- display => array (2)
- view => array (1)
- options => array (3)
- label => string (6) "hidden"
- type => string (9) "timestamp"
- weight => integer 0
- form => array (2)
- options => array (2)
- type => string (18) "datetime_timestamp"
- weight => integer 10
- configurable => boolean true
- provider => string (4) "node"
- field_name => string (7) "created"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1588 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (18) "field_item:created"
- settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1585 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- changed => Drupal\Core\Field\BaseFieldDefinition#1589 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (8)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1590 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (7) "Changed"
- 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 UTF-8 string (8) "Modifié"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1591 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (39) "The time that the node 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 UTF-8 string (69) "La date à laquelle le nœud a été modifié pour la dernière fois."
- revisionable => boolean true
- translatable => boolean true
- provider => string (4) "node"
- field_name => string (7) "changed"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1592 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (18) "field_item:changed"
- settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1589 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- promote => Drupal\Core\Field\Entity\BaseFieldOverride#1536 (36)
- Properties (36)
- Methods (125)
- Static methods (19)
- protected entityTypeId -> string (19) "base_field_override"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (17) "node.page.promote"
- protected status -> boolean true
- protected uuid -> string (36) "ef42ff06-6621-4821-8ffb-9a5b22a6283b"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (1)
- default_config_hash => string (43) "fPUEnm4T5zfZRr3ttDUqq7yCDd2uW3clWD-pvos4tlQ"
- protected trustedData -> boolean false
- protected dependencies -> array (1)
- config => array (1)
- 0 => string (14) "node.type.page"
- protected isSyncing -> boolean false
- protected id -> string (17) "node.page.promote"
- protected field_name -> string (7) "promote"
- protected field_type -> string (7) "boolean"
- protected entity_type -> string (4) "node"
- protected bundle -> string (4) "page"
- protected label -> string (23) "Promu en page d'accueil"
- protected description -> string (0) ""
- protected settings -> array (2)
- on_label => UTF-8 string (7) "Activé"
- off_label => UTF-8 string (11) "Désactivé"
- protected required -> boolean false
- protected translatable -> boolean false
- protected default_value -> array (1)
- 0 => array (1)
- value => integer 0
- protected default_value_callback -> string (0) ""
- protected fieldStorage -> null
- protected itemDefinition -> null
- protected constraints -> array (0)
- protected propertyConstraints -> array (0)
- protected baseFieldDefinition -> null
- public __construct(array $values, $entity_type = 'base_field_override') Constructs a BaseFieldOverride object.
/** * Constructs a BaseFieldOverride object. * * In most cases, base field override entities are created via * BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle') * * @param array $values * An array of base field bundle override properties, keyed by property * name. The field to override is specified by referring to an existing * field 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 bundle field override 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 type of the entity to create. Defaults to * 'base_field_override'. * * @throws \Drupal\Core\Field\FieldException * Exception thrown if $values does not contain a field_name, entity_type or * bundle value. */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:106
- public getFieldStorageDefinition() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:123
- public isDisplayConfigurable($context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:130
- public getDisplayOptions($display_context) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:137
- public isReadOnly() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:144
- public isComputed() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:151
- public isInternal(): bool {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:158
- public getClass() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:165
- public getUniqueIdentifier() {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:172
- protected getBaseFieldDefinition(): \Drupal\Core\Field\BaseFieldDefinition Gets the base field definition.
/** * Gets the base field definition. * * @return \Drupal\Core\Field\BaseFieldDefinition * An associative array of the base field definition. */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:182
- public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} * * @throws \Drupal\Core\Field\FieldException * If the bundle is being changed. */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:196
- public __sleep(): array Implements the magic __sleep() method.
/** * Implements the magic __sleep() method. */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:267
- 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 calculateDependencies() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:235
- public onDependencyRemoval(array $dependencies) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:262
- public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Field\FieldConfigBase Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:275
- 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 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 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 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
- protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * 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
- protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@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
- 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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@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}
/** * {@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
- protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * 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\Core\Field\Entity\BaseFieldOverride::createFromBaseFieldDefinition(Drupal\Core\Field\BaseFieldDefinition $base_field_definition, $bundle): \Drupal\Core\Field\Entity\BaseFieldOverride Creates a base field override object.
/** * Creates a base field override object. * * @param \Drupal\Core\Field\BaseFieldDefinition $base_field_definition * The base field definition to override. * @param string $bundle * The bundle to which the override applies. * * @return \Drupal\Core\Field\Entity\BaseFieldOverride * A new base field override object. */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:75
- public static Drupal\Core\Field\Entity\BaseFieldOverride::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $field_overrides) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:231
- public static Drupal\Core\Field\Entity\BaseFieldOverride::loadByName($entity_type_id, $bundle, $field_name): \Drupal\Core\Field\FieldConfigInterface|null Loads a base field bundle override config entity.
/** * Loads a base field bundle override config entity. * * @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\Core\Field\FieldConfigInterface|null * The base field bundle override config entity if one exists for the * provided field name, otherwise NULL. */ Defined in <drupal>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:260
- 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
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@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
- 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
- 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 $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\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
- sticky => Drupal\Core\Field\BaseFieldDefinition#1598 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (9)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1599 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (22) "Sticky at top of lists"
- 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 UTF-8 string (27) "Epinglé en haut des listes"
- revisionable => boolean true
- translatable => boolean true
- default_value => array (1)
- 0 => array (1)
- value => boolean false
- display => array (1)
- form => array (2)
- options => array (1)
- region => string (6) "hidden"
- configurable => boolean true
- provider => string (4) "node"
- field_name => string (6) "sticky"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1600 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (18) "field_item:boolean"
- settings => array (2)
- on_label => Drupal\Core\StringTranslation\TranslatableMarkup#1601 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (2) "On"
- 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
- on_label string (2) "On"
- off_label => Drupal\Core\StringTranslation\TranslatableMarkup#1602 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (3) "Off"
- 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
- off_label string (3) "Off"
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1598 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- default_langcode => Drupal\Core\Field\BaseFieldDefinition#1603 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (9)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1604 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (19) "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
- label UTF-8 string (22) "Traduction par défaut"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1605 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- 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 UTF-8 string (63) "Un marqueur indiquant s'il s'agit de la traduction par défaut."
- translatable => boolean true
- revisionable => boolean true
- default_value => array (1)
- 0 => array (1)
- value => boolean true
- provider => string (4) "node"
- field_name => string (16) "default_langcode"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1606 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (18) "field_item:boolean"
- settings => array (2)
- on_label => Drupal\Core\StringTranslation\TranslatableMarkup#1607 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (2) "On"
- 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
- on_label string (2) "On"
- off_label => Drupal\Core\StringTranslation\TranslatableMarkup#1608 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (3) "Off"
- 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
- off_label string (3) "Off"
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1603 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- revision_default => Drupal\Core\Field\BaseFieldDefinition#1609 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (10)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1610 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (16) "Default revision"
- 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 UTF-8 string (19) "Version par défaut"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1611 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (72) "A flag indicating whether this was a default revision when it was saved."
- 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 UTF-8 string (100) "Un marqueur indiquant si ceci était la version par défaut au moment où elle ...
Un marqueur indiquant si ceci était la version par défaut au moment où elle a été enregistrée.
- storage_required => boolean true
- internal => boolean true
- translatable => boolean false
- revisionable => boolean true
- provider => string (4) "node"
- field_name => string (16) "revision_default"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1612 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (18) "field_item:boolean"
- settings => array (2)
- on_label => Drupal\Core\StringTranslation\TranslatableMarkup#1613 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (2) "On"
- 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
- on_label string (2) "On"
- off_label => Drupal\Core\StringTranslation\TranslatableMarkup#1614 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (3) "Off"
- 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
- off_label string (3) "Off"
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1609 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- revision_translation_affected => Drupal\Core\Field\BaseFieldDefinition#1615 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (9)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1616 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (29) "Revision translation affected"
- 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 UTF-8 string (31) "Traduction de version impactée"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1617 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (72) "Indicates if the last edit of a translation belongs to current revision."
- 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 UTF-8 string (88) "Indique si la dernière modification d'une traduction appartient à la version...
Indique si la dernière modification d'une traduction appartient à la version actuelle.
- read-only => boolean true
- revisionable => boolean true
- translatable => boolean true
- provider => string (4) "node"
- field_name => string (29) "revision_translation_affected"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1618 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (18) "field_item:boolean"
- settings => array (2)
- on_label => Drupal\Core\StringTranslation\TranslatableMarkup#1619 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (2) "On"
- 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
- on_label string (2) "On"
- off_label => Drupal\Core\StringTranslation\TranslatableMarkup#1620 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (3) "Off"
- 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
- off_label string (3) "Off"
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1615 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- metatag => Drupal\Core\Field\BaseFieldDefinition#1621 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (10)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1622 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- 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 UTF-8 string (59) "Balises meta (champ caché pour la prise en charge du JSON)"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1623 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- 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."
- computed => boolean true
- translatable => boolean true
- read-only => boolean true
- entity_type => string (4) "node"
- cardinality => integer -1
- provider => string (7) "metatag"
- field_name => string (7) "metatag"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1624 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (27) "field_item:metatag_computed"
- settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1621 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- path => Drupal\Core\Field\BaseFieldDefinition#1625 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (8)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1626 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (9) "URL alias"
- 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 (11) "Alias d'URL"
- translatable => boolean true
- display => array (1)
- form => array (2)
- options => array (2)
- type => string (4) "path"
- weight => integer 30
- configurable => boolean true
- computed => boolean true
- provider => string (4) "path"
- field_name => string (4) "path"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1627 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (15) "field_item:path"
- settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1625 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- menu_link => Drupal\Core\Field\BaseFieldDefinition#1628 (7)
- Properties (7)
- Methods (89)
- Static methods (9)
- Class constants (1)
- protected definition -> array (12)
- label => Drupal\Core\StringTranslation\TranslatableMarkup#1629 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (9) "Menu link"
- 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 (12) "Lien du menu"
- description => Drupal\Core\StringTranslation\TranslatableMarkup#1630 (5)
- Properties (5)
- Methods (12)
- Static methods (2)
- toString
- protected string -> string (68) "Computed menu link for the node (only available during node saving)."
- 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 UTF-8 string (94) "Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistr...
Lien de menu calculé pour le nœud (disponible uniquement pendant l'enregistrement du nœud).
- revisionable => boolean true
- class => string (35) "\Drupal\token\MenuLinkFieldItemList"
- translatable => boolean true
- internal => boolean true
- display => array (2)
- view => array (1)
- options => array (2)
- label => string (6) "hidden"
- region => string (6) "hidden"
- form => array (1)
- options => array (1)
- region => string (6) "hidden"
- computed => boolean true
- provider => string (5) "token"
- field_name => string (9) "menu_link"
- entity_type => string (4) "node"
- bundle => null
- protected typedDataManager -> null
- protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#1631 (3)
- Properties (3)
- Methods (39)
- Static methods (4)
- protected definition -> array (2)
- type => string (27) "field_item:entity_reference"
- settings => array (3)
- target_type => string (17) "menu_link_content"
- handler => string (7) "default"
- handler_settings => array (0)
- protected typedDataManager -> null
- protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#1628 Recursion
- 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
- 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} */ Inherited from Drupal\Core\TypedData\DataDefinition 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 $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
- body => Drupal\field\Entity\FieldConfig#1634 (36)
- Properties (36)
- Methods (125)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (14) "node.page.body"
- protected status -> boolean true
- protected uuid -> string (36) "b05f7c01-155a-4bb4-b62a-b77b75e91fcf"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (1)
- default_config_hash => string (43) "rUop-8b6hvxxDYbv-KobTfNIBNbPY9qOPl8f6kBNSpw"
- protected trustedData -> boolean false
- protected dependencies -> array (2)
- config => array (2)
- 0 => string (23) "field.storage.node.body"
- 1 => string (14) "node.type.page"
- module => array (1)
- 0 => string (4) "text"
- protected isSyncing -> boolean false
- protected id -> string (14) "node.page.body"
- protected field_name -> string (4) "body"
- protected field_type -> string (17) "text_with_summary"
- protected entity_type -> string (4) "node"
- protected bundle -> string (4) "page"
- protected label -> string (5) "Corps"
- protected description -> string (0) ""
- protected settings -> array (3)
- display_summary => boolean false
- required_summary => boolean false
- allowed_formats => array (0)
- protected required -> boolean false
- protected translatable -> boolean true
- 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
- protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * 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
- protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@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
- protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * 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
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@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 $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
- field_image => Drupal\field\Entity\FieldConfig#1632 (36)
- Properties (36)
- Methods (125)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (21) "node.page.field_image"
- protected status -> boolean true
- protected uuid -> string (36) "79992ada-6d5e-4e18-882b-5df759b21079"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (1)
- filefield_paths => array (6)
- enabled => boolean true
- file_path => array (2)
- value => string (12) "images/pages"
- options => array (3)
- slashes => boolean false
- pathauto => boolean false
- transliterate => boolean false
- file_name => array (2)
- value => string (59) "[file:ffp-name-only-original].[file:ffp-extension-original]"
- options => array (3)
- slashes => boolean false
- pathauto => boolean false
- transliterate => boolean false
- redirect => boolean false
- retroactive_update => boolean false
- active_updating => boolean false
- protected _core -> array (0)
- protected trustedData -> boolean false
- protected dependencies -> array (2)
- Table (2)
- Contents (2)
0 1 config field.storage.node.field_image node.type.page module filefield_paths image - config => array (2)
- 0 => string (30) "field.storage.node.field_image"
- 1 => string (14) "node.type.page"
- module => array (2)
- 0 => string (15) "filefield_paths"
- 1 => string (5) "image"
- protected isSyncing -> boolean false
- protected id -> string (21) "node.page.field_image"
- protected field_name -> string (11) "field_image"
- protected field_type -> string (5) "image"
- protected entity_type -> string (4) "node"
- protected bundle -> string (4) "page"
- protected label -> string (5) "Image"
- protected description -> UTF-8 string (35) "Image à mettre en haut de la page."
- protected settings -> array (12)
- handler => string (12) "default:file"
- handler_settings => array (0)
- file_directory => string (31) "[date:custom:Y]-[date:custom:m]"
- file_extensions => string (16) "png gif jpg jpeg"
- max_filesize => string (0) ""
- max_resolution => string (0) ""
- min_resolution => string (0) ""
- alt_field => boolean false
- alt_field_required => boolean true
- title_field => boolean false
- title_field_required => boolean false
- default_image => array (5)
- uuid => string (0) ""
- alt => string (0) ""
- title => string (0) ""
- width => null
- height => null
- 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
- protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * 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
- protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@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
- protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * 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
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@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 $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
- field_ordre => Drupal\field\Entity\FieldConfig#1635 (36)
- Properties (36)
- Methods (125)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (21) "node.page.field_ordre"
- protected status -> boolean true
- protected uuid -> string (36) "a3ac8315-3a4c-4c73-8566-1b98d49aa0ea"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- protected dependencies -> array (2)
- config => array (2)
- 0 => string (30) "field.storage.node.field_ordre"
- 1 => string (14) "node.type.page"
- module => array (1)
- 0 => string (6) "weight"
- protected isSyncing -> boolean false
- protected id -> string (21) "node.page.field_ordre"
- protected field_name -> string (11) "field_ordre"
- protected field_type -> string (6) "weight"
- protected entity_type -> string (4) "node"
- protected bundle -> string (4) "page"
- protected label -> string (19) "Ordre dans la liste"
- protected description -> UTF-8 string (124) "Ordre d'affichage dans la liste. Modifié automatiquement par un cliquer / dé...
Ordre d'affichage dans la liste. Modifié automatiquement par un cliquer / déplacer / relâcher dans liste en mode gestion.
- protected settings -> array (1)
- range => string (2) "20"
- protected required -> boolean false
- protected translatable -> boolean false
- protected default_value -> array (1)
- 0 => array (1)
- value => string (1) "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
- protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * 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
- protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@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
- protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * 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
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@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 $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
- field_type_page => Drupal\field\Entity\FieldConfig#1637 (36)
- Properties (36)
- Methods (125)
- Static methods (19)
- protected entityTypeId -> string (12) "field_config"
- protected enforceIsNew -> null
- protected typedData -> null
- protected originalEntity -> null
- protected cacheContexts -> array (1)
- 0 => string (28) "languages:language_interface"
- protected cacheTags -> array (0)
- protected cacheMaxAge -> integer -1
- protected _serviceIds -> array (0)
- protected _entityStorages -> array (0)
- protected originalId -> string (25) "node.page.field_type_page"
- protected status -> boolean true
- protected uuid -> string (36) "9bdce793-1f19-4771-8aeb-85159148a762"
- private isUninstalling -> boolean false
- protected langcode -> string (2) "fr"
- protected third_party_settings -> array (0)
- protected _core -> array (0)
- protected trustedData -> boolean false
- protected dependencies -> array (1)
- config => array (3)
- 0 => string (34) "field.storage.node.field_type_page"
- 1 => string (14) "node.type.page"
- 2 => string (29) "taxonomy.vocabulary.type_page"
- protected isSyncing -> boolean false
- protected id -> string (25) "node.page.field_type_page"
- protected field_name -> string (15) "field_type_page"
- protected field_type -> string (16) "entity_reference"
- protected entity_type -> string (4) "node"
- protected bundle -> string (4) "page"
- protected label -> string (12) "Type de page"
- protected description -> string (0) ""
- protected settings -> array (2)
- handler => string (21) "default:taxonomy_term"
- handler_settings => array (4)
- target_bundles => array (1)
- type_page => string (9) "type_page"
- sort => array (2)
- field => string (4) "name"
- direction => string (3) "asc"
- auto_create => boolean false
- auto_create_bundle => string (0) ""
- protected required -> boolean true
- 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
- protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
/** * 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
- protected invalidateTagsOnSave($update) {@inheritdoc}
/** * {@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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}
/** * {@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
- protected addDependencies(array $dependencies) Adds multiple dependencies.
/** * 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
- protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}
/** * {@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 $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 (4)
- en => Drupal\Core\Language\Language#1505 (5)
- Properties (5)
- Methods (7)
- Static methods (2)
- Static properties (1)
- Class constants (15)
- protected name -> string (7) "Anglais"
- 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)
- id => string (2) "en"\Drupal\Core\Language\Language::$defaultValues['id']
- name => string (7) "English"\Drupal\Core\Language\Language::$defaultValues['name']
- direction => string (3) "ltr"\Drupal\Core\Language\Language::$defaultValues['direction']
- weight => integer 0\Drupal\Core\Language\Language::$defaultValues['weight']
- locked => boolean false\Drupal\Core\Language\Language::$defaultValues['locked']
- id => string (2) "en"
- 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"
- fr => Drupal\Core\Language\Language#1508 (5)
- Properties (5)
- Methods (7)
- Static methods (2)
- Static properties (1)
- Class constants (15)
- protected name -> UTF-8 string (9) "Français"
- protected id -> string (2) "fr"
- protected direction -> string (3) "ltr"
- protected weight -> integer 1
- 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)
- id => string (2) "en"\Drupal\Core\Language\Language::$defaultValues['id']
- name => string (7) "English"\Drupal\Core\Language\Language::$defaultValues['name']
- direction => string (3) "ltr"\Drupal\Core\Language\Language::$defaultValues['direction']
- weight => integer 0\Drupal\Core\Language\Language::$defaultValues['weight']
- locked => boolean false\Drupal\Core\Language\Language::$defaultValues['locked']
- id => string (2) "en"
- 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#1506 (5)
- Properties (5)
- Methods (7)
- Static methods (2)
- Static properties (1)
- Class constants (15)
- protected name -> UTF-8 string (14) "Non spécifié"
- protected id -> string (3) "und"
- 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)
- id => string (2) "en"\Drupal\Core\Language\Language::$defaultValues['id']
- name => string (7) "English"\Drupal\Core\Language\Language::$defaultValues['name']
- direction => string (3) "ltr"\Drupal\Core\Language\Language::$defaultValues['direction']
- weight => integer 0\Drupal\Core\Language\Language::$defaultValues['weight']
- locked => boolean false\Drupal\Core\Language\Language::$defaultValues['locked']
- id => string (2) "en"
- 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#1500 (5)
- Properties (5)
- Methods (7)
- Static methods (2)
- Static properties (1)
- Class constants (15)
- protected name -> string (14) "Non applicable"
- protected id -> string (3) "zxx"
- protected direction -> string (3) "ltr"
- protected weight -> integer 3
- 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)
- id => string (2) "en"\Drupal\Core\Language\Language::$defaultValues['id']
- name => string (7) "English"\Drupal\Core\Language\Language::$defaultValues['name']
- direction => string (3) "ltr"\Drupal\Core\Language\Language::$defaultValues['direction']
- weight => integer 0\Drupal\Core\Language\Language::$defaultValues['weight']
- locked => boolean false\Drupal\Core\Language\Language::$defaultValues['locked']
- id => string (2) "en"
- 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"
- protected langcodeKey -> string (8) "langcode"
- protected defaultLangcodeKey -> string (16) "default_langcode"
- protected activeLangcode -> string (9) "x-default"
- protected enforceDefaultTranslation -> null
- protected defaultLangcode -> string (2) "fr"
- protected translations -> array (1)
- x-default => array (1)
- status => integer 1
- protected translationInitialize -> boolean false
- protected newRevision -> boolean false
- protected isDefaultRevision -> string (1) "1"
- protected entityKeys -> array (4)
- bundle => string (4) "page"
- id => string (3) "134"
- revision => string (3) "136"
- uuid => string (36) "8793de7f-ec8a-4d6f-99c8-d7fa0637c4e5"
- protected translatableEntityKeys -> array (8)
- label => array (1)
- x-default => UTF-8 string (38) "Les Mélodistes et leur belle histoire"
- langcode => array (1)
- x-default => string (2) "fr"
- status => array (1)
- x-default => string (1) "1"
- published => array (1)
- x-default => string (1) "1"
- uid => array (1)
- x-default => string (1) "1"
- owner => array (1)
- x-default => string (1) "1"
- default_langcode => array (1)
- x-default => string (1) "1"
- revision_translation_affected => array (1)
- x-default => string (1) "1"
- protected validated -> boolean false
- protected validationRequired -> boolean false
- protected loadedRevisionId -> string (3) "136"
- protected revisionTranslationAffectedKey -> string (29) "revision_translation_affected"
- protected enforceRevisionTranslationAffected -> array (0)
- protected isSyncing -> boolean false
- public in_preview -> null$0->in_preview
- public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}$0->preSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:117
- public preSaveRevision(Drupal\Core\Entity\EntityStorageInterface $storage, stdClass $record) {@inheritdoc}$0->preSaveRevision()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:139
- public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}$0->postSave()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:154
- public getType() {@inheritdoc}$0->getType()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:204
- public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}$0->access()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:211
- public getTitle() {@inheritdoc}$0->getTitle()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:219
- public setTitle($title) {@inheritdoc}$0->setTitle()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:226
- public getCreatedTime() {@inheritdoc}$0->getCreatedTime()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:234
- public setCreatedTime($timestamp) {@inheritdoc}$0->setCreatedTime()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:241
- public isPromoted() {@inheritdoc}$0->isPromoted()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:249
- public setPromoted($promoted) {@inheritdoc}$0->setPromoted()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:256
- public isSticky() {@inheritdoc}$0->isSticky()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:264
- public setSticky($sticky) {@inheritdoc}$0->setSticky()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:271
- public __construct(array $values, $entity_type, $bundle = false, $translations = array()) {@inheritdoc}new \Drupal\node\Entity\Node()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:201
- protected getLanguages() {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:280
- public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}$0->postCreate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:296
- public setNewRevision($value = true) {@inheritdoc}$0->setNewRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:303
- public getLoadedRevisionId() {@inheritdoc}$0->getLoadedRevisionId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:325
- public updateLoadedRevisionId() {@inheritdoc}$0->updateLoadedRevisionId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:332
- public isNewRevision() {@inheritdoc}$0->isNewRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:340
- public isDefaultRevision($new_value = null) {@inheritdoc}$0->isDefaultRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:347
- public wasDefaultRevision() {@inheritdoc}$0->wasDefaultRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:360
- public isLatestRevision() {@inheritdoc}$0->isLatestRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:375
- public isLatestTranslationAffectedRevision() {@inheritdoc}$0->isLatestTranslationAffectedRevision()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:385
- public isRevisionTranslationAffected() {@inheritdoc}$0->isRevisionTranslationAffected()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:395
- public setRevisionTranslationAffected($affected) {@inheritdoc}$0->setRevisionTranslationAffected()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:402
- public isRevisionTranslationAffectedEnforced() {@inheritdoc}$0->isRevisionTranslationAffectedEnforced()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:412
- public setRevisionTranslationAffectedEnforced($enforced) {@inheritdoc}$0->setRevisionTranslationAffectedEnforced()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:419
- public setDefaultTranslationEnforced(?bool $enforce_default_translation): static Set or clear an override of the isDefaultTranslation() result.$0->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:434
- public isDefaultTranslation() {@inheritdoc}$0->isDefaultTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:442
- public getRevisionId() {@inheritdoc}$0->getRevisionId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:452
- public isTranslatable() {@inheritdoc}$0->isTranslatable()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:459
- public validate() {@inheritdoc}$0->validate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:516
- public isValidationRequired() {@inheritdoc}$0->isValidationRequired()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:525
- public setValidationRequired($required) {@inheritdoc}$0->setValidationRequired()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:532
- 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:540
- public __sleep(): array {@inheritdoc}
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:549
- public id() {@inheritdoc}$0->id()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:567
- public bundle() {@inheritdoc}$0->bundle()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:574
- public getBundleEntity(): ?Drupal\Core\Entity\EntityInterface {@inheritdoc}$0->getBundleEntity()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:581
- public uuid() {@inheritdoc}$0->uuid()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:592
- public hasField($field_name) {@inheritdoc}$0->hasField()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:599
- public get($field_name) {@inheritdoc}$0->get()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:606
- 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:619
- public set($name, $value, $notify = true) {@inheritdoc}$0->set()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:665
- public getFields($include_computed = true) {@inheritdoc}$0->getFields()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:676
- public getTranslatableFields($include_computed = true) {@inheritdoc}$0->getTranslatableFields()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:689
- public getIterator(): ArrayIterator {@inheritdoc}$0->getIterator()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:702
- public getFieldDefinition($name) {@inheritdoc}$0->getFieldDefinition()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:709
- public getFieldDefinitions() {@inheritdoc}$0->getFieldDefinitions()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:721
- public toArray() {@inheritdoc}$0->toArray()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:731
- public language() {@inheritdoc}$0->language()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:756
- 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:778
- 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:811
- public onChange($name) {@inheritdoc}$0->onChange()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:822
- public getTranslation($langcode) {@inheritdoc}$0->getTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:888
- public getUntranslated() {@inheritdoc}$0->getUntranslated()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:923
- 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:941
- public hasTranslation($langcode) {@inheritdoc}$0->hasTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:975
- public isNewTranslation() {@inheritdoc}$0->isNewTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:985
- public addTranslation($langcode, array $values = array()) {@inheritdoc}$0->addTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:992
- public removeTranslation($langcode) {@inheritdoc}$0->removeTranslation()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1013
- public getTranslationStatus($langcode) {@inheritdoc}$0->getTranslationStatus()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1042
- public getTranslationLanguages($include_default = true) {@inheritdoc}$0->getTranslationLanguages()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1052
- public updateOriginalValues() Updates the original values with the interim changes.$0->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:1069
- 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:1089
- 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:1121
- 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:1158
- 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:1170
- public createDuplicate() {@inheritdoc}$0->createDuplicate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1204
- public __clone() Magic method: Implements a deep clone.clone $0
/** * Magic method: Implements a deep clone. */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1242
- public label() {@inheritdoc}$0->label()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1328
- public referencedEntities() {@inheritdoc}$0->referencedEntities()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1337
- 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:1364
- 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:1466
- public hasTranslationChanges() {@inheritdoc}$0->hasTranslationChanges()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1477
- public isDefaultTranslationAffectedOnly() {@inheritdoc}$0->isDefaultTranslationAffectedOnly()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1539
- 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 isNew() {@inheritdoc}$0->isNew()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:136
- public enforceIsNew($value = true) {@inheritdoc}$0->enforceIsNew()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143
- public getEntityTypeId() {@inheritdoc}$0->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->toUrl()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:175
- public hasLinkTemplate($rel) {@inheritdoc}$0->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
- public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}$0->toLink()
/** * {@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->uriRelationships()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315
- public save() {@inheritdoc}$0->save()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:368
- public delete() {@inheritdoc}$0->delete()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376
- public getEntityType() {@inheritdoc}$0->getEntityType()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408
- public getCacheContexts() {@inheritdoc}$0->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->getCacheTagsToInvalidate()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:497
- public getCacheTags() {@inheritdoc}$0->getCacheTags()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507
- public getCacheMaxAge() {@inheritdoc}$0->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->getOriginalId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:599
- public setOriginalId($id) {@inheritdoc}$0->setOriginalId()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:607
- public getTypedData() {@inheritdoc}$0->getTypedData()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628
- public getConfigDependencyKey() {@inheritdoc}$0->getConfigDependencyKey()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673
- public getConfigDependencyName() {@inheritdoc}$0->getConfigDependencyName()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:680
- public getConfigTarget() {@inheritdoc}$0->getConfigTarget()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:687
- public getOriginal(): ?static {@inheritdoc}$0->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->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->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->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->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->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->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->setSyncing()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22
- public isSyncing() {@inheritdoc}$0->isSyncing()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\ContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31
- public getChangedTimeAcrossTranslations(): int Returns the timestamp of the last entity change across all translations.$0->getChangedTimeAcrossTranslations()
/** * Returns the timestamp of the last entity change across all translations. * * @return int * The timestamp of the last entity save operation across all * translations. */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase 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->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. */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase 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->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 */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:46
- public isPublished() {@inheritdoc}$0->isPublished()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:47
- public setPublished() {@inheritdoc}$0->setPublished()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:54
- public setUnpublished() {@inheritdoc}$0->setUnpublished()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:64
- public getRevisionCreationTime() {@inheritdoc}$0->getRevisionCreationTime()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:69
- public setRevisionCreationTime($timestamp) {@inheritdoc}$0->setRevisionCreationTime()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:76
- public getRevisionUser() Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser().$0->getRevisionUser()
/** * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser(). */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:84
- public setRevisionUser(Drupal\user\UserInterface $account) Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser().$0->setRevisionUser()
/** * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser(). */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:91
- public getRevisionUserId() Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId().$0->getRevisionUserId()
/** * Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId(). */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:99
- public setRevisionUserId($user_id) Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId().$0->setRevisionUserId()
/** * Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId(). */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:106
- public getRevisionLogMessage() {@inheritdoc}$0->getRevisionLogMessage()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:114
- public setRevisionLogMessage($revision_log_message) {@inheritdoc}$0->setRevisionLogMessage()
/** * {@inheritdoc} */ Inherited from Drupal\Core\Entity\EditorialContentEntityBase Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:121
- public getOwnerId() {@inheritdoc}$0->getOwnerId()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:48
- public setOwnerId($uid) {@inheritdoc}$0->setOwnerId()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:55
- public getOwner() {@inheritdoc}$0->getOwner()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:65
- public setOwner(Drupal\user\UserInterface $account) {@inheritdoc}$0->setOwner()
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:73
- 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 preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}
- public static Drupal\node\Entity\Node::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:180
- public static Drupal\node\Entity\Node::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $nodes) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:196
- public static Drupal\node\Entity\Node::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/modules/node/src/Entity/Node.php:279
- public static Drupal\Core\Entity\ContentEntityBase::create(array $values = array()) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1187
- 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:1456
- 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
- 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\EditorialContentEntityBase::publishedBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\BaseFieldDefinition[] Returns an array of base field definitions for publishing status.
/** * Returns an array of base field definitions for publishing status. * * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type * The entity type to add the publishing status field to. * * @return \Drupal\Core\Field\BaseFieldDefinition[] * An array of base field definitions. * * @throws \Drupal\Core\Entity\Exception\UnsupportedEntityTypeDefinitionException * Thrown when the entity type does not implement EntityPublishedInterface * or if it does not have a "published" entity key. */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:27
- public static Drupal\Core\Entity\EditorialContentEntityBase::revisionLogBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\FieldDefinitionInterface[] Provides revision-related base field definitions for an entity type.
/** * Provides revision-related base field definitions for an entity type. * * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type * The entity type definition. * * @return \Drupal\Core\Field\FieldDefinitionInterface[] * An array of base field definitions for the entity type, keyed by field * name. * * @see \Drupal\Core\Entity\FieldableEntityInterface::baseFieldDefinitions() */ Defined in <drupal>/core/lib/Drupal/Core/Entity/RevisionLogEntityTrait.php:28
- public static Drupal\node\Entity\Node::ownerBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\BaseFieldDefinition[] Returns an array of base field definitions for entity owners.
/** * Returns an array of base field definitions for entity owners. * * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type * The entity type to add the owner field to. * * @return \Drupal\Core\Field\BaseFieldDefinition[] * An array of base field definitions. * * @throws \Drupal\Core\Entity\Exception\UnsupportedEntityTypeDefinitionException * Thrown when the entity type does not implement EntityOwnerInterface or * if it does not have an "owner" entity key. */ Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:28
- public static Drupal\node\Entity\Node::getDefaultEntityOwner(): mixed Default value callback for 'owner' base field.
/** * Default value callback for 'owner' base field. * * @return mixed * A default value for the owner field. */ Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:86
- public static Drupal\Core\Entity\EditorialContentEntityBase::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/EditorialContentEntityBase.php:19
- 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::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\ContentEntityBase::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}
/** * {@inheritdoc} */ Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1398
- 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\Entity\ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck :: array (0)
- public const Drupal\Core\TypedData\TranslationStatusInterface::TRANSLATION_REMOVED :: integer 0
- public const Drupal\Core\TypedData\TranslationStatusInterface::TRANSLATION_EXISTING :: integer 1
- public const Drupal\Core\TypedData\TranslationStatusInterface::TRANSLATION_CREATED :: integer 2
- public const Drupal\node\NodeInterface::NOT_PUBLISHED :: integer 0
- public const Drupal\node\NodeInterface::PUBLISHED :: integer 1
- public const Drupal\node\NodeInterface::NOT_PROMOTED :: integer 0
- public const Drupal\node\NodeInterface::PROMOTED :: integer 1
- public const Drupal\node\NodeInterface::NOT_STICKY :: integer 0
- public const Drupal\node\NodeInterface::STICKY :: integer 1
- ⇄Drupal\Core\Entity\FieldableEntityInterface Iterator Contents uninitialized Blacklistediterator_to_array($0, false)
- ⇄Drupal\Core\Entity\FieldableEntityInterface Iterator Contents uninitialized Blacklisted