2019-07-13 11:28:07
2019-07-07 10:37:33
2019-07-13 11:28:07
<p>Le colline del prosecco di Conegliano e Valdobbiadene (Treviso) sono state dichiarate Patrimonio mondiale dell'umanità dall'Unesco.</p> <p> </p> <a href="https://alcanevon.com/sites/default/files/2019-07/conegliano_valdobbiadene_unesco_2019.mp4"><img alt="Il video delle colline Conegliano Valdobbiadene Patrimonio dell'Unesco" data-align="center" data-entity-type="file" data-entity-uuid="c099c9f0-3dfb-4bd1-82ee-289753010a1c" src="/sites/default/files/inline-images/video_patrimonio_unesco.jpg" /></a> <p> </p> <p>Da Baku (Azerbaigian), in occasione della 43° sessione del Comitato del Patrimonio mondiale Unesco, i 21 Stati membri del Comitato eleggono all’unanimità le Colline del Prosecco di Conegliano e Valdobbiadene patrimonio mondiale dell’umanità. Nelle parole del ministro Moavero Milanesi: «si riconosce il valore universale di un paesaggio culturale e agricolo unico, scaturito da una straordinaria, sapiente interazione tra un'attività produttiva di eccellenza e la natura di un territorio affascinante».</p> <p> </p> <p>«Le nostre colline, fanno parte di un territorio affascinante non solo dal punto di vista paesaggistico ma anche per storia e cultura che danno un valore a quello che noi definiamo il nostro Territorio — così ha commentato Manuela Geronazzo, titolare al Canevon — e finalmente c’è un riconoscimento in più per tutelare questa bellezza».</p> <p>Non è un caso infatti, che il Prosecco Superiore Docg sia uno dei vini Made in Italy più esportati, con una produzione che ha saputo conquistare apprezzamenti su scala mondiale! Come al Canevon, lo dimostrano le tante medaglie ricevute dall’Azienda, tra cui, solo quest’anno:</p> <ul> <li><a href="https://alcanevon.com/it/2019/medaglia-bronzo-decanter-2019-brut-al-canevon">Medaglia di bronzo</a> al Decanter 2019 per il Brut al Canevon</li> <li><a href="https://alcanevon.com/it/2019/medaglia-argento-mundus-vini-2019-cuve-millesimato">Medaglia d'argento</a> al Mundus Vini 2019 per il Cuvé Millesimato</li> </ul> <p>E la produzione è intimamente connessa con le caratteristiche del territorio e del meraviglioso paesaggio delle Colline del Prosecco di Conegliano-Valdobbiadene, che sono già tutelate dal Consorzio Tutela del Vino Conegliano Valdobbiadene Prosecco ma che da oggi hanno un’ulteriore riconoscimento da parte dell’Unesco.</p> <p> </p> <p>Con questa proclamazione, salgono a 55 i siti italiani protetti dall’Unesco, un primato che il Bel Paese può vantare su tutti gli altri Paesi.</p> <p> </p>
<p>Le Colline del Prosecco di Coneliano-Valdobbiadene sono state proclamate patrimonio mondiale dell'umanità dall'Unesco. A convincere i 21 membri, la straordinaria bellezza ma anche la cultura e la tradizione agricola.</p>
*DEPTH TOO GREAT*
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 <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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", array('@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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
Magic __sleep() method to avoid serializing the string translator. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
Implements the magic __toString() method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
Returns the string length. @return int The length of the string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
Gets all arguments from this translated string. @return mixed[] The array of arguments. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
Gets all options from this translated string. @return mixed[] The array of options. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
Gets the untranslated string value stored in this translated string. @return string The string stored in this wrapper. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:118
Renders the object as a string. @return string The translated string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
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. Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:264
Replaces placeholders in a string with values. @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. @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 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: When the placeholder replacement value is: - A string, the replaced value in the returned string will be sanitized using \Drupal\Component\Utility\Html::escape(). - A MarkupInterface object, the replaced value in the returned string will not be sanitized. - A MarkupInterface object cast to a string, the replaced value in the returned string be forcibly sanitized using \Drupal\Component\Utility\Html::escape(). @code $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object)); @endcode Use this placeholder as the default choice for anything displayed on the site, but not within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - %variable: Use when the replacement value is to be wrapped in <em> tags. A call like: @code $string = "%output_text"; $arguments = ['%output_text' => 'text output here.']; $this->placeholderFormat($string, $arguments); @endcode makes the following HTML code: @code <em class="placeholder">text output here.</em> @endcode As with @variable, do not use this within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - :variable: 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 attribute value is always wrapped in quotes: @code // Secure (with quotes): $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]); // Insecure (without quotes): $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]); @endcode When ":variable" comes from arbitrary user input, the result is secure, but not guaranteed to be a valid URL (which means the resulting output could fail HTML validation). To guarantee a valid URL, use Url::fromUri($user_input)->toString() (which either throws an exception or returns a well-formed URL) before passing the result into a ":variable" placeholder. @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() Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:194
For test purposes, wrap die() in an overridable method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
Gets the string translation service. @return \Drupal\Core\StringTranslation\TranslationInterface The string translation service. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
Creates a new field definition. @param string $type The type of the field. @return static A new field definition object. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
Magic method: Implements a deep clone. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:861
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:658
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:373
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:735
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:824
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:466
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:459
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:452
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:438
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:777
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 (array() for no default value). Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:518
Returns the name of the field that will be used for getting initial values. @return string|null The field name. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:554
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:632
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:614
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:625
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:708
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:688
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:668
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:791
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:784
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:804
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:445
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:878
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:294
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:835
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:766
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:483
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:503
Sets whether the field storage is deleted. @param bool $deleted Whether the field storage is deleted. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:426
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 'type' = '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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:408
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:537
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:578
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the item definition. @param \Drupal\Core\TypedData\DataDefinition $definition A list item's data definition. @return $this Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
Sets the field name. @param string $name The field name to set. @return static The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:334
Sets the name of the provider of this field. @param string $provider The provider name to set. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
Sets whether the field is queryable. @param bool $queryable Whether the field is queryable. @return static The object itself for chaining. @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Field\BaseFieldDefinition::setCustomStorage() instead. @see https://www.drupal.org/node/2856563 Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:313
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
Sets whether the field is revisionable. @param bool $revisionable Whether the field is revisionable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
{@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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:853
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:700
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:680
Sets whether the field is translatable. @param bool $translatable Whether the field is translatable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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 <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Helper to retrieve the field item class. @deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\TypedData\ListDataDefinition::getClass() instead. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
*DEPTH TOO GREAT*
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 <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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", array('@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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
Magic __sleep() method to avoid serializing the string translator. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
Implements the magic __toString() method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
Returns the string length. @return int The length of the string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
Gets all arguments from this translated string. @return mixed[] The array of arguments. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
Gets all options from this translated string. @return mixed[] The array of options. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
Gets the untranslated string value stored in this translated string. @return string The string stored in this wrapper. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:118
Renders the object as a string. @return string The translated string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
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. Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:264
Replaces placeholders in a string with values. @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. @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 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: When the placeholder replacement value is: - A string, the replaced value in the returned string will be sanitized using \Drupal\Component\Utility\Html::escape(). - A MarkupInterface object, the replaced value in the returned string will not be sanitized. - A MarkupInterface object cast to a string, the replaced value in the returned string be forcibly sanitized using \Drupal\Component\Utility\Html::escape(). @code $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object)); @endcode Use this placeholder as the default choice for anything displayed on the site, but not within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - %variable: Use when the replacement value is to be wrapped in <em> tags. A call like: @code $string = "%output_text"; $arguments = ['%output_text' => 'text output here.']; $this->placeholderFormat($string, $arguments); @endcode makes the following HTML code: @code <em class="placeholder">text output here.</em> @endcode As with @variable, do not use this within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - :variable: 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 attribute value is always wrapped in quotes: @code // Secure (with quotes): $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]); // Insecure (without quotes): $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]); @endcode When ":variable" comes from arbitrary user input, the result is secure, but not guaranteed to be a valid URL (which means the resulting output could fail HTML validation). To guarantee a valid URL, use Url::fromUri($user_input)->toString() (which either throws an exception or returns a well-formed URL) before passing the result into a ":variable" placeholder. @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() Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:194
For test purposes, wrap die() in an overridable method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
Gets the string translation service. @return \Drupal\Core\StringTranslation\TranslationInterface The string translation service. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
Creates a new field definition. @param string $type The type of the field. @return static A new field definition object. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
Magic method: Implements a deep clone. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:861
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:658
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:373
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:735
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:824
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:466
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:459
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:452
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:438
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:777
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 (array() for no default value). Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:518
Returns the name of the field that will be used for getting initial values. @return string|null The field name. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:554
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:632
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:614
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:625
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:708
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:688
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:668
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:791
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:784
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:804
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:445
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:878
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:294
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:835
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:766
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:483
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:503
Sets whether the field storage is deleted. @param bool $deleted Whether the field storage is deleted. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:426
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 'type' = '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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:408
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:537
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:578
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the item definition. @param \Drupal\Core\TypedData\DataDefinition $definition A list item's data definition. @return $this Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
Sets the field name. @param string $name The field name to set. @return static The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:334
Sets the name of the provider of this field. @param string $provider The provider name to set. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
Sets whether the field is queryable. @param bool $queryable Whether the field is queryable. @return static The object itself for chaining. @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Field\BaseFieldDefinition::setCustomStorage() instead. @see https://www.drupal.org/node/2856563 Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:313
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
Sets whether the field is revisionable. @param bool $revisionable Whether the field is revisionable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
{@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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:853
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:700
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:680
Sets whether the field is translatable. @param bool $translatable Whether the field is translatable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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 <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Helper to retrieve the field item class. @deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\TypedData\ListDataDefinition::getClass() instead. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
*DEPTH TOO GREAT*
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 <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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", array('@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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
Magic __sleep() method to avoid serializing the string translator. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
Implements the magic __toString() method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
Returns the string length. @return int The length of the string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
Gets all arguments from this translated string. @return mixed[] The array of arguments. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
Gets all options from this translated string. @return mixed[] The array of options. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
Gets the untranslated string value stored in this translated string. @return string The string stored in this wrapper. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:118
Renders the object as a string. @return string The translated string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
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. Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:264
Replaces placeholders in a string with values. @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. @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 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: When the placeholder replacement value is: - A string, the replaced value in the returned string will be sanitized using \Drupal\Component\Utility\Html::escape(). - A MarkupInterface object, the replaced value in the returned string will not be sanitized. - A MarkupInterface object cast to a string, the replaced value in the returned string be forcibly sanitized using \Drupal\Component\Utility\Html::escape(). @code $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object)); @endcode Use this placeholder as the default choice for anything displayed on the site, but not within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - %variable: Use when the replacement value is to be wrapped in <em> tags. A call like: @code $string = "%output_text"; $arguments = ['%output_text' => 'text output here.']; $this->placeholderFormat($string, $arguments); @endcode makes the following HTML code: @code <em class="placeholder">text output here.</em> @endcode As with @variable, do not use this within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - :variable: 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 attribute value is always wrapped in quotes: @code // Secure (with quotes): $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]); // Insecure (without quotes): $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]); @endcode When ":variable" comes from arbitrary user input, the result is secure, but not guaranteed to be a valid URL (which means the resulting output could fail HTML validation). To guarantee a valid URL, use Url::fromUri($user_input)->toString() (which either throws an exception or returns a well-formed URL) before passing the result into a ":variable" placeholder. @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() Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:194
For test purposes, wrap die() in an overridable method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
Gets the string translation service. @return \Drupal\Core\StringTranslation\TranslationInterface The string translation service. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
Creates a new field definition. @param string $type The type of the field. @return static A new field definition object. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
Magic method: Implements a deep clone. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:861
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:658
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:373
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:735
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:824
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:466
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:459
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:452
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:438
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:777
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 (array() for no default value). Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:518
Returns the name of the field that will be used for getting initial values. @return string|null The field name. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:554
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:632
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:614
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:625
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:708
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:688
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:668
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:791
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:784
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:804
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:445
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:878
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:294
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:835
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:766
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:483
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:503
Sets whether the field storage is deleted. @param bool $deleted Whether the field storage is deleted. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:426
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 'type' = '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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:408
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:537
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:578
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the item definition. @param \Drupal\Core\TypedData\DataDefinition $definition A list item's data definition. @return $this Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
Sets the field name. @param string $name The field name to set. @return static The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:334
Sets the name of the provider of this field. @param string $provider The provider name to set. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
Sets whether the field is queryable. @param bool $queryable Whether the field is queryable. @return static The object itself for chaining. @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Field\BaseFieldDefinition::setCustomStorage() instead. @see https://www.drupal.org/node/2856563 Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:313
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
Sets whether the field is revisionable. @param bool $revisionable Whether the field is revisionable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
{@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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:853
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:700
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:680
Sets whether the field is translatable. @param bool $translatable Whether the field is translatable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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 <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Helper to retrieve the field item class. @deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\TypedData\ListDataDefinition::getClass() instead. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
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 <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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", array('@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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
Magic __sleep() method to avoid serializing the string translator. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
Implements the magic __toString() method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
Returns the string length. @return int The length of the string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
Gets all arguments from this translated string. @return mixed[] The array of arguments. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
Gets all options from this translated string. @return mixed[] The array of options. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
Gets the untranslated string value stored in this translated string. @return string The string stored in this wrapper. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:118
Renders the object as a string. @return string The translated string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
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. Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:264
Replaces placeholders in a string with values. @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. @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 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: When the placeholder replacement value is: - A string, the replaced value in the returned string will be sanitized using \Drupal\Component\Utility\Html::escape(). - A MarkupInterface object, the replaced value in the returned string will not be sanitized. - A MarkupInterface object cast to a string, the replaced value in the returned string be forcibly sanitized using \Drupal\Component\Utility\Html::escape(). @code $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object)); @endcode Use this placeholder as the default choice for anything displayed on the site, but not within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - %variable: Use when the replacement value is to be wrapped in <em> tags. A call like: @code $string = "%output_text"; $arguments = ['%output_text' => 'text output here.']; $this->placeholderFormat($string, $arguments); @endcode makes the following HTML code: @code <em class="placeholder">text output here.</em> @endcode As with @variable, do not use this within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - :variable: 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 attribute value is always wrapped in quotes: @code // Secure (with quotes): $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]); // Insecure (without quotes): $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]); @endcode When ":variable" comes from arbitrary user input, the result is secure, but not guaranteed to be a valid URL (which means the resulting output could fail HTML validation). To guarantee a valid URL, use Url::fromUri($user_input)->toString() (which either throws an exception or returns a well-formed URL) before passing the result into a ":variable" placeholder. @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() Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:194
For test purposes, wrap die() in an overridable method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
Gets the string translation service. @return \Drupal\Core\StringTranslation\TranslationInterface The string translation service. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
*DEPTH TOO GREAT*
*DEPTH TOO GREAT*
Creates a new field definition. @param string $type The type of the field. @return static A new field definition object. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
Magic method: Implements a deep clone. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:861
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:658
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:373
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:735
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:824
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:466
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:459
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:452
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:438
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:777
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 (array() for no default value). Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:518
Returns the name of the field that will be used for getting initial values. @return string|null The field name. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:554
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:632
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:614
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:625
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:708
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:688
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:668
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:791
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:784
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:804
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:445
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:878
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:294
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:835
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:766
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:483
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:503
Sets whether the field storage is deleted. @param bool $deleted Whether the field storage is deleted. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:426
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 'type' = '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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:408
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:537
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:578
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the item definition. @param \Drupal\Core\TypedData\DataDefinition $definition A list item's data definition. @return $this Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
Sets the field name. @param string $name The field name to set. @return static The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:334
Sets the name of the provider of this field. @param string $provider The provider name to set. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
Sets whether the field is queryable. @param bool $queryable Whether the field is queryable. @return static The object itself for chaining. @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Field\BaseFieldDefinition::setCustomStorage() instead. @see https://www.drupal.org/node/2856563 Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:313
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
Sets whether the field is revisionable. @param bool $revisionable Whether the field is revisionable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
{@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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:853
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:700
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:680
Sets whether the field is translatable. @param bool $translatable Whether the field is translatable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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 <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Helper to retrieve the field item class. @deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\TypedData\ListDataDefinition::getClass() instead. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
*DEPTH TOO GREAT*
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 <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
Creates a new field definition. @param string $type The type of the field. @return static A new field definition object. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
Magic method: Implements a deep clone. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:861
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:658
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:373
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:735
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:824
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:466
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:459
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:452
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:438
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:777
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 (array() for no default value). Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:518
Returns the name of the field that will be used for getting initial values. @return string|null The field name. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:554
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:632
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:614
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:625
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:708
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:688
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:668
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:791
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:784
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:804
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:445
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:878
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:294
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:835
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:766
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:483
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:503
Sets whether the field storage is deleted. @param bool $deleted Whether the field storage is deleted. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:426
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 'type' = '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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:408
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:537
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:578
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the item definition. @param \Drupal\Core\TypedData\DataDefinition $definition A list item's data definition. @return $this Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
Sets the field name. @param string $name The field name to set. @return static The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:334
Sets the name of the provider of this field. @param string $provider The provider name to set. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
Sets whether the field is queryable. @param bool $queryable Whether the field is queryable. @return static The object itself for chaining. @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Field\BaseFieldDefinition::setCustomStorage() instead. @see https://www.drupal.org/node/2856563 Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:313
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
Sets whether the field is revisionable. @param bool $revisionable Whether the field is revisionable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
{@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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:853
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:700
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:680
Sets whether the field is translatable. @param bool $translatable Whether the field is translatable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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 <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Helper to retrieve the field item class. @deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\TypedData\ListDataDefinition::getClass() instead. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
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 <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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", array('@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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
Magic __sleep() method to avoid serializing the string translator. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
Implements the magic __toString() method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
Returns the string length. @return int The length of the string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
Gets all arguments from this translated string. @return mixed[] The array of arguments. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
Gets all options from this translated string. @return mixed[] The array of options. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
Gets the untranslated string value stored in this translated string. @return string The string stored in this wrapper. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:118
Renders the object as a string. @return string The translated string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
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. Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:264
Replaces placeholders in a string with values. @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. @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 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: When the placeholder replacement value is: - A string, the replaced value in the returned string will be sanitized using \Drupal\Component\Utility\Html::escape(). - A MarkupInterface object, the replaced value in the returned string will not be sanitized. - A MarkupInterface object cast to a string, the replaced value in the returned string be forcibly sanitized using \Drupal\Component\Utility\Html::escape(). @code $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object)); @endcode Use this placeholder as the default choice for anything displayed on the site, but not within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - %variable: Use when the replacement value is to be wrapped in <em> tags. A call like: @code $string = "%output_text"; $arguments = ['%output_text' => 'text output here.']; $this->placeholderFormat($string, $arguments); @endcode makes the following HTML code: @code <em class="placeholder">text output here.</em> @endcode As with @variable, do not use this within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - :variable: 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 attribute value is always wrapped in quotes: @code // Secure (with quotes): $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]); // Insecure (without quotes): $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]); @endcode When ":variable" comes from arbitrary user input, the result is secure, but not guaranteed to be a valid URL (which means the resulting output could fail HTML validation). To guarantee a valid URL, use Url::fromUri($user_input)->toString() (which either throws an exception or returns a well-formed URL) before passing the result into a ":variable" placeholder. @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() Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:194
For test purposes, wrap die() in an overridable method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
Gets the string translation service. @return \Drupal\Core\StringTranslation\TranslationInterface The string translation service. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
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", array('@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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
Magic __sleep() method to avoid serializing the string translator. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
Implements the magic __toString() method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
Returns the string length. @return int The length of the string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
Gets all arguments from this translated string. @return mixed[] The array of arguments. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
Gets all options from this translated string. @return mixed[] The array of options. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
Gets the untranslated string value stored in this translated string. @return string The string stored in this wrapper. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:118
Renders the object as a string. @return string The translated string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
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. Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:264
Replaces placeholders in a string with values. @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. @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 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: When the placeholder replacement value is: - A string, the replaced value in the returned string will be sanitized using \Drupal\Component\Utility\Html::escape(). - A MarkupInterface object, the replaced value in the returned string will not be sanitized. - A MarkupInterface object cast to a string, the replaced value in the returned string be forcibly sanitized using \Drupal\Component\Utility\Html::escape(). @code $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object)); @endcode Use this placeholder as the default choice for anything displayed on the site, but not within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - %variable: Use when the replacement value is to be wrapped in <em> tags. A call like: @code $string = "%output_text"; $arguments = ['%output_text' => 'text output here.']; $this->placeholderFormat($string, $arguments); @endcode makes the following HTML code: @code <em class="placeholder">text output here.</em> @endcode As with @variable, do not use this within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - :variable: 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 attribute value is always wrapped in quotes: @code // Secure (with quotes): $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]); // Insecure (without quotes): $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]); @endcode When ":variable" comes from arbitrary user input, the result is secure, but not guaranteed to be a valid URL (which means the resulting output could fail HTML validation). To guarantee a valid URL, use Url::fromUri($user_input)->toString() (which either throws an exception or returns a well-formed URL) before passing the result into a ":variable" placeholder. @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() Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:194
For test purposes, wrap die() in an overridable method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
Gets the string translation service. @return \Drupal\Core\StringTranslation\TranslationInterface The string translation service. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
Creates a new field definition. @param string $type The type of the field. @return static A new field definition object. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
Magic method: Implements a deep clone. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:861
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:658
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:373
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:735
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:824
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:466
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:459
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:452
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:438
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:777
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 (array() for no default value). Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:518
Returns the name of the field that will be used for getting initial values. @return string|null The field name. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:554
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:632
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:614
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:625
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:708
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:688
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:668
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:791
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:784
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:804
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:445
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:878
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:294
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:835
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:766
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:483
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:503
Sets whether the field storage is deleted. @param bool $deleted Whether the field storage is deleted. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:426
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 'type' = '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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:408
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:537
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:578
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the item definition. @param \Drupal\Core\TypedData\DataDefinition $definition A list item's data definition. @return $this Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
Sets the field name. @param string $name The field name to set. @return static The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:334
Sets the name of the provider of this field. @param string $provider The provider name to set. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
Sets whether the field is queryable. @param bool $queryable Whether the field is queryable. @return static The object itself for chaining. @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Field\BaseFieldDefinition::setCustomStorage() instead. @see https://www.drupal.org/node/2856563 Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:313
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
Sets whether the field is revisionable. @param bool $revisionable Whether the field is revisionable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
{@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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:853
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:700
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:680
Sets whether the field is translatable. @param bool $translatable Whether the field is translatable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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 <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Helper to retrieve the field item class. @deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\TypedData\ListDataDefinition::getClass() instead. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
*DEPTH TOO GREAT*
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 <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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", array('@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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
Magic __sleep() method to avoid serializing the string translator. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
Implements the magic __toString() method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
Returns the string length. @return int The length of the string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
Gets all arguments from this translated string. @return mixed[] The array of arguments. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
Gets all options from this translated string. @return mixed[] The array of options. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
Gets the untranslated string value stored in this translated string. @return string The string stored in this wrapper. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:118
Renders the object as a string. @return string The translated string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
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. Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:264
Replaces placeholders in a string with values. @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. @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 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: When the placeholder replacement value is: - A string, the replaced value in the returned string will be sanitized using \Drupal\Component\Utility\Html::escape(). - A MarkupInterface object, the replaced value in the returned string will not be sanitized. - A MarkupInterface object cast to a string, the replaced value in the returned string be forcibly sanitized using \Drupal\Component\Utility\Html::escape(). @code $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object)); @endcode Use this placeholder as the default choice for anything displayed on the site, but not within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - %variable: Use when the replacement value is to be wrapped in <em> tags. A call like: @code $string = "%output_text"; $arguments = ['%output_text' => 'text output here.']; $this->placeholderFormat($string, $arguments); @endcode makes the following HTML code: @code <em class="placeholder">text output here.</em> @endcode As with @variable, do not use this within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - :variable: 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 attribute value is always wrapped in quotes: @code // Secure (with quotes): $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]); // Insecure (without quotes): $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]); @endcode When ":variable" comes from arbitrary user input, the result is secure, but not guaranteed to be a valid URL (which means the resulting output could fail HTML validation). To guarantee a valid URL, use Url::fromUri($user_input)->toString() (which either throws an exception or returns a well-formed URL) before passing the result into a ":variable" placeholder. @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() Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:194
For test purposes, wrap die() in an overridable method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
Gets the string translation service. @return \Drupal\Core\StringTranslation\TranslationInterface The string translation service. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
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", array('@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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
Magic __sleep() method to avoid serializing the string translator. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
Implements the magic __toString() method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
Returns the string length. @return int The length of the string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
Gets all arguments from this translated string. @return mixed[] The array of arguments. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
Gets all options from this translated string. @return mixed[] The array of options. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
Gets the untranslated string value stored in this translated string. @return string The string stored in this wrapper. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:118
Renders the object as a string. @return string The translated string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
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. Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:264
Replaces placeholders in a string with values. @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. @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 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: When the placeholder replacement value is: - A string, the replaced value in the returned string will be sanitized using \Drupal\Component\Utility\Html::escape(). - A MarkupInterface object, the replaced value in the returned string will not be sanitized. - A MarkupInterface object cast to a string, the replaced value in the returned string be forcibly sanitized using \Drupal\Component\Utility\Html::escape(). @code $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object)); @endcode Use this placeholder as the default choice for anything displayed on the site, but not within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - %variable: Use when the replacement value is to be wrapped in <em> tags. A call like: @code $string = "%output_text"; $arguments = ['%output_text' => 'text output here.']; $this->placeholderFormat($string, $arguments); @endcode makes the following HTML code: @code <em class="placeholder">text output here.</em> @endcode As with @variable, do not use this within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - :variable: 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 attribute value is always wrapped in quotes: @code // Secure (with quotes): $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]); // Insecure (without quotes): $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]); @endcode When ":variable" comes from arbitrary user input, the result is secure, but not guaranteed to be a valid URL (which means the resulting output could fail HTML validation). To guarantee a valid URL, use Url::fromUri($user_input)->toString() (which either throws an exception or returns a well-formed URL) before passing the result into a ":variable" placeholder. @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() Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:194
For test purposes, wrap die() in an overridable method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
Gets the string translation service. @return \Drupal\Core\StringTranslation\TranslationInterface The string translation service. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
Creates a new field definition. @param string $type The type of the field. @return static A new field definition object. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
Magic method: Implements a deep clone. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:861
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:658
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:373
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:735
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:824
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:466
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:459
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:452
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:438
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:777
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 (array() for no default value). Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:518
Returns the name of the field that will be used for getting initial values. @return string|null The field name. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:554
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:632
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:614
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:625
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:708
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:688
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:668
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:791
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:784
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:804
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:445
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:878
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:294
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:835
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:766
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:483
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:503
Sets whether the field storage is deleted. @param bool $deleted Whether the field storage is deleted. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:426
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 'type' = '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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:408
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:537
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:578
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the item definition. @param \Drupal\Core\TypedData\DataDefinition $definition A list item's data definition. @return $this Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
Sets the field name. @param string $name The field name to set. @return static The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:334
Sets the name of the provider of this field. @param string $provider The provider name to set. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
Sets whether the field is queryable. @param bool $queryable Whether the field is queryable. @return static The object itself for chaining. @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Field\BaseFieldDefinition::setCustomStorage() instead. @see https://www.drupal.org/node/2856563 Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:313
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
Sets whether the field is revisionable. @param bool $revisionable Whether the field is revisionable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
{@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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:853
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:700
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:680
Sets whether the field is translatable. @param bool $translatable Whether the field is translatable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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 <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Helper to retrieve the field item class. @deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\TypedData\ListDataDefinition::getClass() instead. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
*DEPTH TOO GREAT*
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 <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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", array('@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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
Magic __sleep() method to avoid serializing the string translator. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
Implements the magic __toString() method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
Returns the string length. @return int The length of the string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
Gets all arguments from this translated string. @return mixed[] The array of arguments. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
Gets all options from this translated string. @return mixed[] The array of options. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
Gets the untranslated string value stored in this translated string. @return string The string stored in this wrapper. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:118
Renders the object as a string. @return string The translated string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
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. Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:264
Replaces placeholders in a string with values. @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. @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 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: When the placeholder replacement value is: - A string, the replaced value in the returned string will be sanitized using \Drupal\Component\Utility\Html::escape(). - A MarkupInterface object, the replaced value in the returned string will not be sanitized. - A MarkupInterface object cast to a string, the replaced value in the returned string be forcibly sanitized using \Drupal\Component\Utility\Html::escape(). @code $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object)); @endcode Use this placeholder as the default choice for anything displayed on the site, but not within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - %variable: Use when the replacement value is to be wrapped in <em> tags. A call like: @code $string = "%output_text"; $arguments = ['%output_text' => 'text output here.']; $this->placeholderFormat($string, $arguments); @endcode makes the following HTML code: @code <em class="placeholder">text output here.</em> @endcode As with @variable, do not use this within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - :variable: 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 attribute value is always wrapped in quotes: @code // Secure (with quotes): $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]); // Insecure (without quotes): $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]); @endcode When ":variable" comes from arbitrary user input, the result is secure, but not guaranteed to be a valid URL (which means the resulting output could fail HTML validation). To guarantee a valid URL, use Url::fromUri($user_input)->toString() (which either throws an exception or returns a well-formed URL) before passing the result into a ":variable" placeholder. @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() Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:194
For test purposes, wrap die() in an overridable method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
Gets the string translation service. @return \Drupal\Core\StringTranslation\TranslationInterface The string translation service. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
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", array('@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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129
Magic __sleep() method to avoid serializing the string translator. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203
Implements the magic __toString() method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13
Returns the string length. @return int The length of the string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227
Gets all arguments from this translated string. @return mixed[] The array of arguments. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178
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 <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158
Gets all options from this translated string. @return mixed[] The array of options. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168
Gets the untranslated string value stored in this translated string. @return string The string stored in this wrapper. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145
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 <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:118
Renders the object as a string. @return string The translated string. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188
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. Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:264
Replaces placeholders in a string with values. @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. @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 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: When the placeholder replacement value is: - A string, the replaced value in the returned string will be sanitized using \Drupal\Component\Utility\Html::escape(). - A MarkupInterface object, the replaced value in the returned string will not be sanitized. - A MarkupInterface object cast to a string, the replaced value in the returned string be forcibly sanitized using \Drupal\Component\Utility\Html::escape(). @code $this->placeholderFormat('This will force HTML-escaping of the replacement value: @text', ['@text' => (string) $safe_string_interface_object)); @endcode Use this placeholder as the default choice for anything displayed on the site, but not within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - %variable: Use when the replacement value is to be wrapped in <em> tags. A call like: @code $string = "%output_text"; $arguments = ['%output_text' => 'text output here.']; $this->placeholderFormat($string, $arguments); @endcode makes the following HTML code: @code <em class="placeholder">text output here.</em> @endcode As with @variable, do not use this within HTML attributes, JavaScript, or CSS. Doing so is a security risk. - :variable: 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 attribute value is always wrapped in quotes: @code // Secure (with quotes): $this->placeholderFormat('<a href=":url">@variable</a>', [':url' => $url, '@variable' => $variable]); // Insecure (without quotes): $this->placeholderFormat('<a href=:url>@variable</a>', [':url' => $url, '@variable' => $variable]); @endcode When ":variable" comes from arbitrary user input, the result is secure, but not guaranteed to be a valid URL (which means the resulting output could fail HTML validation). To guarantee a valid URL, use Url::fromUri($user_input)->toString() (which either throws an exception or returns a well-formed URL) before passing the result into a ":variable" placeholder. @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() Inherited from Drupal\Component\Render\FormattableMarkup Defined in <ROOT>/core/lib/Drupal/Component/Render/FormattableMarkup.php:194
For test purposes, wrap die() in an overridable method. Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31
Gets the string translation service. @return \Drupal\Core\StringTranslation\TranslationInterface The string translation service. Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213
*DEPTH TOO GREAT*
*DEPTH TOO GREAT*
Creates a new field definition. @param string $type The type of the field. @return static A new field definition object. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101
Magic method: Implements a deep clone. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:861
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:658
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:373
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:735
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:824
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:466
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:459
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:452
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:438
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:777
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 (array() for no default value). Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:518
Returns the name of the field that will be used for getting initial values. @return string|null The field name. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:554
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:632
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:587
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:614
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:625
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:708
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:688
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:668
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131
Gets the typed data manager. @return \Drupal\Core\TypedData\TypedDataManagerInterface The typed data manager. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:791
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:784
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:804
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:445
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:878
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:294
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123
{@inheritdoc} Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:835
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:304
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:316
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:329
{@inheritdoc} This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:339
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:285
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:766
{@inheritdoc} Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:483
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:503
Sets whether the field storage is deleted. @param bool $deleted Whether the field storage is deleted. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:816
Sets the human-readable description. @param string $description The description to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:426
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 'type' = '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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:408
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:537
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:578
Sets the whether the data value should be internal. @param bool $internal Whether the data value should be internal. @return $this Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:381
Sets the item definition. @param \Drupal\Core\TypedData\DataDefinition $definition A list item's data definition. @return $this Inherited from Drupal\Core\TypedData\ListDataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104
Sets the human-readable label. @param string $label The label to set. @return static The object itself for chaining. Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87
Sets the field name. @param string $name The field name to set. @return static The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:334
Sets the name of the provider of this field. @param string $provider The provider name to set. @return $this Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206
Sets whether the field is queryable. @param bool $queryable Whether the field is queryable. @return static The object itself for chaining. @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Field\BaseFieldDefinition::setCustomStorage() instead. @see https://www.drupal.org/node/2856563 Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:313
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140
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 <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182
Sets whether the field is revisionable. @param bool $revisionable Whether the field is revisionable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186
{@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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:853
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:700
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 <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:680
Sets whether the field is translatable. @param bool $translatable Whether the field is translatable. @return $this The object itself for chaining. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227
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 <ROOT>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25
Returns all definition values as array. @return array Inherited from Drupal\Core\TypedData\DataDefinition Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:348
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 <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Helper to retrieve the field item class. @deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\TypedData\ListDataDefinition::getClass() instead. Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:547
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 <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:63
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:456
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:527
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 static The base field bundle override config entity if one exists for the provided field name, otherwise NULL. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:242
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:537
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:213
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:478
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:453
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:556
Helper callback for uasort() to sort configuration entities by weight and label. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229
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'. @see entity_create() @throws \Drupal\Core\Field\FieldException Exception thrown if $values does not contain a field_name, entity_type or bundle value. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:96
Implements the magic __sleep() method. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:249
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:65
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:361
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:552
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:573
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:159
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:231
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:218
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:400
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:175
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:491
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:520
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:510
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:415
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:148
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:537
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:649
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:458
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:465
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:505
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:498
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:474
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:394
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:426
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:411
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:444
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:313
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:426
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:152
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:113
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:513
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:298
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:203
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:120
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:344
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:224
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:217
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:549
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:517
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:529
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:210
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:630
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:155
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:252
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:196
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:141
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:120
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:590
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:588
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:481
Overrides Entity::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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:144
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:134
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:379
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:32
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:328
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:211
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:166
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:375
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:398
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:258
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:271
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:284
{@inheritdoc} @throws \Drupal\Core\Field\FieldException If the bundle is being changed. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:178
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:484
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:544
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:418
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:433
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:320
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:305
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:560
[@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:386
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:371
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:189
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:23
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:336
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:204
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:197
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:243
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:406
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:30
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:597
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:536
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:339
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:390
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:381
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:129
Gets the configuration manager. @return \Drupal\Core\Config\ConfigManager The configuration manager. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:583
{@inheritdoc} Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:502
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. Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Adds multiple dependencies. @param array $dependencies An array of dependencies keyed by the type of dependency. One example: @code array( 'module' => array( 'node', 'field', 'image', ), ); @endcode @see \Drupal\Core\Entity\DependencyTrait::addDependency Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:430
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 <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
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 <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:92
Gets the entity manager. @return \Drupal\Core\Entity\EntityManagerInterface @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0. Use \Drupal::entityTypeManager() instead in most cases. If the needed method is not on \Drupal\Core\Entity\EntityTypeManagerInterface, see the deprecated \Drupal\Core\Entity\EntityManager to find the correct interface or service. Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:78
Gets the entity type bundle info service. @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:97
Gets the entity type manager. @return \Drupal\Core\Entity\EntityTypeManagerInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:88
Gets the base field definition. @return \Drupal\Core\Field\BaseFieldDefinition Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:164
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 <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
Gets the typed config manager. @return \Drupal\Core\Config\TypedConfigManagerInterface Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:279
{@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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:492
Gets the language manager. @return \Drupal\Core\Language\LanguageManagerInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:106
Gets an array link templates. @return array An array of link templates containing paths. Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:263
Wraps the module handler. @return \Drupal\Core\Extension\ModuleHandlerInterface The module handler. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:102
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 <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
Wraps the theme handler. @return \Drupal\Core\Extension\ThemeHandlerInterface The theme handler. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:112
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 <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:318
Gets the UUID generator. @return \Drupal\Component\Uuid\UuidInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:115
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:547
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 <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:63
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:456
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:527
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 static The base field bundle override config entity if one exists for the provided field name, otherwise NULL. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:242
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:537
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:213
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:478
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:453
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:556
Helper callback for uasort() to sort configuration entities by weight and label. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229
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'. @see entity_create() @throws \Drupal\Core\Field\FieldException Exception thrown if $values does not contain a field_name, entity_type or bundle value. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:96
Implements the magic __sleep() method. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:249
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:65
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:361
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:552
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:573
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:159
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:231
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:218
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:400
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:175
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:491
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:520
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:510
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:415
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:148
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:537
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:649
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:458
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:465
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:505
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:498
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:474
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:394
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:426
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:411
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:444
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:313
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:426
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:152
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:113
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:513
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:298
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:203
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:120
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:344
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:224
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:217
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:549
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:517
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:529
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:210
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:630
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:155
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:252
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:196
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:141
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:120
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:590
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:588
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:481
Overrides Entity::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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:144
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:134
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:379
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:32
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:328
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:211
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:166
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:375
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:398
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:258
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:271
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:284
{@inheritdoc} @throws \Drupal\Core\Field\FieldException If the bundle is being changed. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:178
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:484
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:544
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:418
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:433
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:320
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:305
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:560
[@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:386
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:371
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:189
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:23
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:336
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:204
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:197
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:243
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:406
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:30
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:597
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:536
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:339
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:390
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:381
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:129
Gets the configuration manager. @return \Drupal\Core\Config\ConfigManager The configuration manager. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:583
{@inheritdoc} Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:502
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. Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Adds multiple dependencies. @param array $dependencies An array of dependencies keyed by the type of dependency. One example: @code array( 'module' => array( 'node', 'field', 'image', ), ); @endcode @see \Drupal\Core\Entity\DependencyTrait::addDependency Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:430
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 <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
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 <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:92
Gets the entity manager. @return \Drupal\Core\Entity\EntityManagerInterface @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0. Use \Drupal::entityTypeManager() instead in most cases. If the needed method is not on \Drupal\Core\Entity\EntityTypeManagerInterface, see the deprecated \Drupal\Core\Entity\EntityManager to find the correct interface or service. Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:78
Gets the entity type bundle info service. @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:97
Gets the entity type manager. @return \Drupal\Core\Entity\EntityTypeManagerInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:88
Gets the base field definition. @return \Drupal\Core\Field\BaseFieldDefinition Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:164
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 <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
Gets the typed config manager. @return \Drupal\Core\Config\TypedConfigManagerInterface Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:279
{@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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:492
Gets the language manager. @return \Drupal\Core\Language\LanguageManagerInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:106
Gets an array link templates. @return array An array of link templates containing paths. Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:263
Wraps the module handler. @return \Drupal\Core\Extension\ModuleHandlerInterface The module handler. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:102
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 <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
Wraps the theme handler. @return \Drupal\Core\Extension\ThemeHandlerInterface The theme handler. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:112
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 <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:318
Gets the UUID generator. @return \Drupal\Component\Uuid\UuidInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:115
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:547
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 <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:63
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:456
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:527
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 static The base field bundle override config entity if one exists for the provided field name, otherwise NULL. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:242
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:537
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:213
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:478
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:453
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:556
Helper callback for uasort() to sort configuration entities by weight and label. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229
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'. @see entity_create() @throws \Drupal\Core\Field\FieldException Exception thrown if $values does not contain a field_name, entity_type or bundle value. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:96
Implements the magic __sleep() method. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:249
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:65
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:361
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:552
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:573
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:159
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:231
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:218
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:400
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:175
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:491
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:520
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:510
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:415
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:148
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:537
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:649
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:458
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:465
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:505
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:498
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:474
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:394
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:426
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:411
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:444
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:313
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:426
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:152
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:113
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:513
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:298
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:203
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:120
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:344
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:224
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:217
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:549
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:517
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:529
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:210
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:630
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:155
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:252
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:196
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:141
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:120
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:590
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:588
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:481
Overrides Entity::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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:144
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:134
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:379
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:32
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:328
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:211
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:166
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:375
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:398
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:258
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:271
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:284
{@inheritdoc} @throws \Drupal\Core\Field\FieldException If the bundle is being changed. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:178
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:484
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:544
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:418
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:433
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:320
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:305
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:560
[@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:386
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:371
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:189
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:23
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:336
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:204
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:197
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:243
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:406
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:30
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:597
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:536
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:339
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:390
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:381
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:129
Gets the configuration manager. @return \Drupal\Core\Config\ConfigManager The configuration manager. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:583
{@inheritdoc} Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:502
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. Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Adds multiple dependencies. @param array $dependencies An array of dependencies keyed by the type of dependency. One example: @code array( 'module' => array( 'node', 'field', 'image', ), ); @endcode @see \Drupal\Core\Entity\DependencyTrait::addDependency Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:430
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 <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
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 <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:92
Gets the entity manager. @return \Drupal\Core\Entity\EntityManagerInterface @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0. Use \Drupal::entityTypeManager() instead in most cases. If the needed method is not on \Drupal\Core\Entity\EntityTypeManagerInterface, see the deprecated \Drupal\Core\Entity\EntityManager to find the correct interface or service. Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:78
Gets the entity type bundle info service. @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:97
Gets the entity type manager. @return \Drupal\Core\Entity\EntityTypeManagerInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:88
Gets the base field definition. @return \Drupal\Core\Field\BaseFieldDefinition Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:164
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 <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
Gets the typed config manager. @return \Drupal\Core\Config\TypedConfigManagerInterface Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:279
{@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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:492
Gets the language manager. @return \Drupal\Core\Language\LanguageManagerInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:106
Gets an array link templates. @return array An array of link templates containing paths. Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:263
Wraps the module handler. @return \Drupal\Core\Extension\ModuleHandlerInterface The module handler. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:102
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 <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
Wraps the theme handler. @return \Drupal\Core\Extension\ThemeHandlerInterface The theme handler. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:112
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 <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:318
Gets the UUID generator. @return \Drupal\Component\Uuid\UuidInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:115
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:547
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 <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:63
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:456
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:527
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 static The base field bundle override config entity if one exists for the provided field name, otherwise NULL. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:242
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:537
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:213
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:478
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:453
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:556
Helper callback for uasort() to sort configuration entities by weight and label. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229
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'. @see entity_create() @throws \Drupal\Core\Field\FieldException Exception thrown if $values does not contain a field_name, entity_type or bundle value. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:96
Implements the magic __sleep() method. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:249
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:65
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:361
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:552
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:573
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:159
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:231
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:218
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:400
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:175
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:491
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:520
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:510
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:415
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:148
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:537
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:649
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:458
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:465
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:505
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:498
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:474
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:394
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:426
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:411
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:444
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:313
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:426
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:152
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:113
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:513
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:298
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:203
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:120
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:344
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:224
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:217
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:549
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:517
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:529
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:210
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:630
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:155
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:252
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:196
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:141
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:120
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:590
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:588
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:481
Overrides Entity::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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:144
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:134
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:379
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:32
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:328
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:211
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:166
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:375
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:398
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:258
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:271
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:284
{@inheritdoc} @throws \Drupal\Core\Field\FieldException If the bundle is being changed. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:178
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:484
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:544
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:418
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:433
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:320
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:305
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:560
[@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:386
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:371
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:189
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:23
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:336
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:204
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:197
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:243
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:406
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:30
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:597
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:536
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:339
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:390
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:381
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:129
Gets the configuration manager. @return \Drupal\Core\Config\ConfigManager The configuration manager. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:583
{@inheritdoc} Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:502
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. Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Adds multiple dependencies. @param array $dependencies An array of dependencies keyed by the type of dependency. One example: @code array( 'module' => array( 'node', 'field', 'image', ), ); @endcode @see \Drupal\Core\Entity\DependencyTrait::addDependency Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:430
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 <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
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 <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:92
Gets the entity manager. @return \Drupal\Core\Entity\EntityManagerInterface @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0. Use \Drupal::entityTypeManager() instead in most cases. If the needed method is not on \Drupal\Core\Entity\EntityTypeManagerInterface, see the deprecated \Drupal\Core\Entity\EntityManager to find the correct interface or service. Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:78
Gets the entity type bundle info service. @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:97
Gets the entity type manager. @return \Drupal\Core\Entity\EntityTypeManagerInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:88
Gets the base field definition. @return \Drupal\Core\Field\BaseFieldDefinition Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:164
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 <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
Gets the typed config manager. @return \Drupal\Core\Config\TypedConfigManagerInterface Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:279
{@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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:492
Gets the language manager. @return \Drupal\Core\Language\LanguageManagerInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:106
Gets an array link templates. @return array An array of link templates containing paths. Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:263
Wraps the module handler. @return \Drupal\Core\Extension\ModuleHandlerInterface The module handler. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:102
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 <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
Wraps the theme handler. @return \Drupal\Core\Extension\ThemeHandlerInterface The theme handler. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:112
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 <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:318
Gets the UUID generator. @return \Drupal\Component\Uuid\UuidInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:115
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:547
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 <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:63
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:456
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:527
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 static The base field bundle override config entity if one exists for the provided field name, otherwise NULL. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:242
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:537
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:213
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:478
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:453
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:556
Helper callback for uasort() to sort configuration entities by weight and label. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229
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'. @see entity_create() @throws \Drupal\Core\Field\FieldException Exception thrown if $values does not contain a field_name, entity_type or bundle value. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:96
Implements the magic __sleep() method. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:249
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:65
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:361
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:552
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:573
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:159
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:231
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:218
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:400
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:175
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:491
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:520
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:510
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:415
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:148
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:537
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:649
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:458
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:465
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:505
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:498
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:474
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:394
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:426
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:411
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:444
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:313
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:426
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:152
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:113
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:513
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:298
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:203
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:120
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:344
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:224
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:217
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:549
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:517
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:529
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:210
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:630
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:155
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:252
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:196
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:141
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:120
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:590
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:588
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:481
Overrides Entity::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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:144
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:134
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:379
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:32
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:328
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:211
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:166
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:375
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:398
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:258
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:271
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:284
{@inheritdoc} @throws \Drupal\Core\Field\FieldException If the bundle is being changed. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:178
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:484
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:544
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:418
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:433
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:320
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:305
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:560
[@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:386
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:371
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:189
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:23
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:336
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:204
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:197
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:243
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:406
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:30
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:597
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:536
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:339
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:390
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:381
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:129
Gets the configuration manager. @return \Drupal\Core\Config\ConfigManager The configuration manager. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:583
{@inheritdoc} Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:502
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. Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Adds multiple dependencies. @param array $dependencies An array of dependencies keyed by the type of dependency. One example: @code array( 'module' => array( 'node', 'field', 'image', ), ); @endcode @see \Drupal\Core\Entity\DependencyTrait::addDependency Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:430
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 <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
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 <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:92
Gets the entity manager. @return \Drupal\Core\Entity\EntityManagerInterface @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0. Use \Drupal::entityTypeManager() instead in most cases. If the needed method is not on \Drupal\Core\Entity\EntityTypeManagerInterface, see the deprecated \Drupal\Core\Entity\EntityManager to find the correct interface or service. Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:78
Gets the entity type bundle info service. @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:97
Gets the entity type manager. @return \Drupal\Core\Entity\EntityTypeManagerInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:88
Gets the base field definition. @return \Drupal\Core\Field\BaseFieldDefinition Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:164
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 <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33
Gets the typed config manager. @return \Drupal\Core\Config\TypedConfigManagerInterface Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:279
{@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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:492
Gets the language manager. @return \Drupal\Core\Language\LanguageManagerInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:106
Gets an array link templates. @return array An array of link templates containing paths. Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:263
Wraps the module handler. @return \Drupal\Core\Extension\ModuleHandlerInterface The module handler. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:102
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 <ROOT>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39
Wraps the theme handler. @return \Drupal\Core\Extension\ThemeHandlerInterface The theme handler. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:112
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 <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:318
Gets the UUID generator. @return \Drupal\Component\Uuid\UuidInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:115
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:547
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 <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:63
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:456
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:527
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 static The base field bundle override config entity if one exists for the provided field name, otherwise NULL. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:242
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:537
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:213
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:478
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:453
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:556
Helper callback for uasort() to sort configuration entities by weight and label. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229
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'. @see entity_create() @throws \Drupal\Core\Field\FieldException Exception thrown if $values does not contain a field_name, entity_type or bundle value. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:96
Implements the magic __sleep() method. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:249
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:65
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:361
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:31
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:41
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:552
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:573
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:159
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:231
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:218
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:400
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:182
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:175
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:143
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:491
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:520
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:510
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:415
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:148
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:537
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:649
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:458
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:465
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:505
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:498
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:474
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:394
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:426
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:411
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:444
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:313
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:127
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:426
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:152
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:113
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:513
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:298
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:203
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:120
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:359
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:344
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:224
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:217
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:549
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:517
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:529
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:210
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:630
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:155
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:252
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:196
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:141
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:120
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:590
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:588
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:481
Overrides Entity::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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:144
{@inheritdoc} Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:134
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:379
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:32
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:328
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:211
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:166
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:375
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:398
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:51
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:258
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:271
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:284
{@inheritdoc} @throws \Drupal\Core\Field\FieldException If the bundle is being changed. Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:178
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:484
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:544
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:418
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:433
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:320
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:305
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:560
[@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:386
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:371
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:351
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:189
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:23
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509
{@inheritdoc} Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldConfigBase.php:336
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:204
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:197
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:243
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:278
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:406
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:30
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:597
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:536
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:339
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:390
{@inheritdoc} Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:381
{@inheritdoc} Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:129
Gets the configuration manager. @return \Drupal\Core\Config\ConfigManager The configuration manager. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:583
{@inheritdoc} Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:502
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. Inherited from Drupal\Core\Field\FieldConfigBase Defined in <ROOT>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26
Adds multiple dependencies. @param array $dependencies An array of dependencies keyed by the type of dependency. One example: @code array( 'module' => array( 'node', 'field', 'image', ), ); @endcode @see \Drupal\Core\Entity\DependencyTrait::addDependency Inherited from Drupal\Core\Config\Entity\ConfigEntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64
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 <ROOT>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:430
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 <ROOT>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31
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 <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:92
Gets the entity manager. @return \Drupal\Core\Entity\EntityManagerInterface @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0. Use \Drupal::entityTypeManager() instead in most cases. If the needed method is not on \Drupal\Core\Entity\EntityTypeManagerInterface, see the deprecated \Drupal\Core\Entity\EntityManager to find the correct interface or service. Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:78
Gets the entity type bundle info service. @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:97
Gets the entity type manager. @return \Drupal\Core\Entity\EntityTypeManagerInterface Inherited from Drupal\Core\Entity\EntityBase Defined in <ROOT>/core/lib/Drupal/Core/Entity/EntityBase.php:88
Gets the base field definition. @return \Drupal\Core\Field\BaseFieldDefinition Defined in <ROOT>/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php:164
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 <ROOT>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33