• contents
• Available methods (41)

• protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition(7) *RECURSION*

  →protected definition -> array(2)

  'type' => string(18) "field_item:integer"

  →'settings' => array(6)

  'unsigned' => boolTRUE

  'size' => string(6) "normal"

  'min' => string(0) ""

  'max' => string(0) ""

  'prefix' => string(0) ""

  'suffix' => string(0) ""

  protected typedDataManager -> NULL

• →public static create($field_definition) -> static

  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

  →public static createFromDataType($data_type)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

  →public __construct(array $values = array())

  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

  →public __sleep()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355

  →public addConstraint($constraint_name, $options = NULL)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293

  →public getClass()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

  →public getConstraint($constraint_name)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270

  →public getConstraints()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

  →public getDataType()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

  →public getDescription()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

  →public getFieldDefinition()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

  →public getLabel()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

  →public getMainPropertyName()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

  →public getPropertyDefinition($name)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

  →public getPropertyDefinitions()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

  →public getSetting($setting_name)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

  →public getSettings()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

  →public getTypedDataManager() -> \Drupal\Core\TypedData\TypedDataManagerInterface

  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

  →public isComputed()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

  →public isInternal()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365

  →public isList()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

  →public isReadOnly()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

  →public isRequired()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

  →public offsetExists($offset)

  {@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

  →public &offsetGet($offset)

  {@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

  →public offsetSet($offset, $value)

  {@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

  →public offsetUnset($offset)

  {@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

  →public setClass($class) -> static

  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

  →public setComputed($computed) -> static

  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

  →public setConstraints(array $constraints) -> $this

  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

  →public setDataType($type) -> static

  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

  →public setDescription($description) -> static

  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

  →public setFieldDefinition($field_definition)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

  →public setInternal($internal) -> $this

  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

  →public setLabel($label) -> static

  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

  →public setReadOnly($read_only) -> static

  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

  →public setRequired($required) -> static

  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

  →public setSetting($setting_name, $value) -> static

  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

  →public setSettings(array $settings) -> static

  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

  →public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager) -> $this

  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

  →public toArray() -> array

  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

→'label' => Drupal\Core\StringTranslation\TranslatableMarkup(5)

• contents
• Available methods (14)

• protected translatedMarkup -> NULL

  protected options -> array(0)

  protected stringTranslation -> NULL

  protected string -> string(7) "Term ID"

  protected arguments -> array(0)

• →public __construct($string, array $arguments = array(), array $options = array(), Drupal\Core\StringTranslation\TranslationInterface $string_translation = NULL)

  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

  →public __sleep()

  Magic __sleep() method to avoid serializing the string translator.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

  →public __toString()

  Implements the magic __toString() method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

  →public count() -> int

  Returns the string length.
  
  @return int
  The length of the string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

  →public getArguments() -> mixed[]

  Gets all arguments from this translated string.
  
  @return mixed[]
  The array of arguments.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

  →public getOption($name) -> mixed

  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

  →public getOptions() -> mixed[]

  Gets all options from this translated string.
  
  @return mixed[]
  The array of options.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

  →public getUntranslatedString() -> string

  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

  →public jsonSerialize() -> string

  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

  →public render() -> string

  Renders the object as a string.
  
  @return string
  The translated string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

  →protected static placeholderEscape($value) -> string

  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

  →protected static placeholderFormat($string, array $args) -> string

  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

  →protected _die()

  For test purposes, wrap die() in an overridable method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

  →protected getStringTranslation() -> \Drupal\Core\StringTranslation\TranslationInterface

  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

'read-only' => boolTRUE

→'description' => Drupal\Core\StringTranslation\TranslatableMarkup(5)

• contents
• Available methods (14)

• protected translatedMarkup -> NULL

  protected options -> array(0)

  protected stringTranslation -> NULL

  protected string -> string(12) "The term ID."

  protected arguments -> array(0)

• →public __construct($string, array $arguments = array(), array $options = array(), Drupal\Core\StringTranslation\TranslationInterface $string_translation = NULL)

  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

  →public __sleep()

  Magic __sleep() method to avoid serializing the string translator.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

  →public __toString()

  Implements the magic __toString() method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

  →public count() -> int

  Returns the string length.
  
  @return int
  The length of the string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

  →public getArguments() -> mixed[]

  Gets all arguments from this translated string.
  
  @return mixed[]
  The array of arguments.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

  →public getOption($name) -> mixed

  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

  →public getOptions() -> mixed[]

  Gets all options from this translated string.
  
  @return mixed[]
  The array of options.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

  →public getUntranslatedString() -> string

  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

  →public jsonSerialize() -> string

  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

  →public render() -> string

  Renders the object as a string.
  
  @return string
  The translated string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

  →protected static placeholderEscape($value) -> string

  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

  →protected static placeholderFormat($string, array $args) -> string

  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

  →protected _die()

  For test purposes, wrap die() in an overridable method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

  →protected getStringTranslation() -> \Drupal\Core\StringTranslation\TranslationInterface

  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

'provider' => string(8) "taxonomy"

'field_name' => string(3) "tid"

'entity_type' => string(13) "taxonomy_term"

'bundle' => NULL

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 is removed from 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 is removed from drupal:9.0.0. Use
\Drupal\Core\TypedData\ListDataDefinition::getClass() instead.

Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643

• contents
• Available methods (41)

• protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition(7) *RECURSION*

  →protected definition -> array(2)

  'type' => string(15) "field_item:uuid"

  →'settings' => array(3)

  'max_length' => integer128

  'is_ascii' => boolTRUE

  'case_sensitive' => boolFALSE

  protected typedDataManager -> NULL

• →public static create($field_definition) -> static

  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

  →public static createFromDataType($data_type)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

  →public __construct(array $values = array())

  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

  →public __sleep()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355

  →public addConstraint($constraint_name, $options = NULL)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293

  →public getClass()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

  →public getConstraint($constraint_name)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270

  →public getConstraints()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

  →public getDataType()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

  →public getDescription()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

  →public getFieldDefinition()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

  →public getLabel()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

  →public getMainPropertyName()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

  →public getPropertyDefinition($name)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

  →public getPropertyDefinitions()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

  →public getSetting($setting_name)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

  →public getSettings()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

  →public getTypedDataManager() -> \Drupal\Core\TypedData\TypedDataManagerInterface

  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

  →public isComputed()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

  →public isInternal()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365

  →public isList()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

  →public isReadOnly()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

  →public isRequired()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

  →public offsetExists($offset)

  {@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

  →public &offsetGet($offset)

  {@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

  →public offsetSet($offset, $value)

  {@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

  →public offsetUnset($offset)

  {@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

  →public setClass($class) -> static

  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

  →public setComputed($computed) -> static

  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

  →public setConstraints(array $constraints) -> $this

  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

  →public setDataType($type) -> static

  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

  →public setDescription($description) -> static

  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

  →public setFieldDefinition($field_definition)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

  →public setInternal($internal) -> $this

  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

  →public setLabel($label) -> static

  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

  →public setReadOnly($read_only) -> static

  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

  →public setRequired($required) -> static

  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

  →public setSetting($setting_name, $value) -> static

  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

  →public setSettings(array $settings) -> static

  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

  →public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager) -> $this

  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

  →public toArray() -> array

  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

→'label' => Drupal\Core\StringTranslation\TranslatableMarkup(5)

• contents
• Available methods (14)

• protected translatedMarkup -> NULL

  protected options -> array(0)

  protected stringTranslation -> NULL

  protected string -> string(4) "UUID"

  protected arguments -> array(0)

• →public __construct($string, array $arguments = array(), array $options = array(), Drupal\Core\StringTranslation\TranslationInterface $string_translation = NULL)

  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

  →public __sleep()

  Magic __sleep() method to avoid serializing the string translator.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

  →public __toString()

  Implements the magic __toString() method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

  →public count() -> int

  Returns the string length.
  
  @return int
  The length of the string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

  →public getArguments() -> mixed[]

  Gets all arguments from this translated string.
  
  @return mixed[]
  The array of arguments.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

  →public getOption($name) -> mixed

  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

  →public getOptions() -> mixed[]

  Gets all options from this translated string.
  
  @return mixed[]
  The array of options.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

  →public getUntranslatedString() -> string

  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

  →public jsonSerialize() -> string

  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

  →public render() -> string

  Renders the object as a string.
  
  @return string
  The translated string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

  →protected static placeholderEscape($value) -> string

  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

  →protected static placeholderFormat($string, array $args) -> string

  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

  →protected _die()

  For test purposes, wrap die() in an overridable method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

  →protected getStringTranslation() -> \Drupal\Core\StringTranslation\TranslationInterface

  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

'read-only' => boolTRUE

→'description' => Drupal\Core\StringTranslation\TranslatableMarkup(5)

• contents
• Available methods (14)

• protected translatedMarkup -> NULL

  protected options -> array(0)

  protected stringTranslation -> NULL

  protected string -> string(14) "The term UUID."

  protected arguments -> array(0)

• →public __construct($string, array $arguments = array(), array $options = array(), Drupal\Core\StringTranslation\TranslationInterface $string_translation = NULL)

  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

  →public __sleep()

  Magic __sleep() method to avoid serializing the string translator.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

  →public __toString()

  Implements the magic __toString() method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

  →public count() -> int

  Returns the string length.
  
  @return int
  The length of the string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

  →public getArguments() -> mixed[]

  Gets all arguments from this translated string.
  
  @return mixed[]
  The array of arguments.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

  →public getOption($name) -> mixed

  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

  →public getOptions() -> mixed[]

  Gets all options from this translated string.
  
  @return mixed[]
  The array of options.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

  →public getUntranslatedString() -> string

  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

  →public jsonSerialize() -> string

  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

  →public render() -> string

  Renders the object as a string.
  
  @return string
  The translated string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

  →protected static placeholderEscape($value) -> string

  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

  →protected static placeholderFormat($string, array $args) -> string

  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

  →protected _die()

  For test purposes, wrap die() in an overridable method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

  →protected getStringTranslation() -> \Drupal\Core\StringTranslation\TranslationInterface

  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

'provider' => string(8) "taxonomy"

'field_name' => string(4) "uuid"

'entity_type' => string(13) "taxonomy_term"

'bundle' => NULL

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 is removed from 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 is removed from drupal:9.0.0. Use
\Drupal\Core\TypedData\ListDataDefinition::getClass() instead.

Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643

• contents
• Available methods (41)

• protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition(7) *RECURSION*

  →protected definition -> array(2)

  'type' => string(18) "field_item:integer"

  →'settings' => array(6)

  'unsigned' => boolTRUE

  'size' => string(6) "normal"

  'min' => string(0) ""

  'max' => string(0) ""

  'prefix' => string(0) ""

  'suffix' => string(0) ""

  protected typedDataManager -> NULL

• →public static create($field_definition) -> static

  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

  →public static createFromDataType($data_type)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

  →public __construct(array $values = array())

  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

  →public __sleep()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355

  →public addConstraint($constraint_name, $options = NULL)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293

  →public getClass()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

  →public getConstraint($constraint_name)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270

  →public getConstraints()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

  →public getDataType()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

  →public getDescription()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

  →public getFieldDefinition()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

  →public getLabel()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

  →public getMainPropertyName()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

  →public getPropertyDefinition($name)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

  →public getPropertyDefinitions()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

  →public getSetting($setting_name)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

  →public getSettings()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

  →public getTypedDataManager() -> \Drupal\Core\TypedData\TypedDataManagerInterface

  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

  →public isComputed()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

  →public isInternal()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365

  →public isList()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

  →public isReadOnly()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

  →public isRequired()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

  →public offsetExists($offset)

  {@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

  →public &offsetGet($offset)

  {@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

  →public offsetSet($offset, $value)

  {@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

  →public offsetUnset($offset)

  {@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

  →public setClass($class) -> static

  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

  →public setComputed($computed) -> static

  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

  →public setConstraints(array $constraints) -> $this

  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

  →public setDataType($type) -> static

  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

  →public setDescription($description) -> static

  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

  →public setFieldDefinition($field_definition)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

  →public setInternal($internal) -> $this

  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

  →public setLabel($label) -> static

  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

  →public setReadOnly($read_only) -> static

  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

  →public setRequired($required) -> static

  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

  →public setSetting($setting_name, $value) -> static

  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

  →public setSettings(array $settings) -> static

  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

  →public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager) -> $this

  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

  →public toArray() -> array

  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

→'label' => Drupal\Core\StringTranslation\TranslatableMarkup(5)

• contents
• Available methods (14)

• protected translatedMarkup -> NULL

  protected options -> array(0)

  protected stringTranslation -> NULL

  protected string -> string(11) "Revision ID"

  protected arguments -> array(0)

• →public __construct($string, array $arguments = array(), array $options = array(), Drupal\Core\StringTranslation\TranslationInterface $string_translation = NULL)

  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

  →public __sleep()

  Magic __sleep() method to avoid serializing the string translator.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

  →public __toString()

  Implements the magic __toString() method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

  →public count() -> int

  Returns the string length.
  
  @return int
  The length of the string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

  →public getArguments() -> mixed[]

  Gets all arguments from this translated string.
  
  @return mixed[]
  The array of arguments.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

  →public getOption($name) -> mixed

  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

  →public getOptions() -> mixed[]

  Gets all options from this translated string.
  
  @return mixed[]
  The array of options.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

  →public getUntranslatedString() -> string

  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

  →public jsonSerialize() -> string

  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

  →public render() -> string

  Renders the object as a string.
  
  @return string
  The translated string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

  →protected static placeholderEscape($value) -> string

  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

  →protected static placeholderFormat($string, array $args) -> string

  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

  →protected _die()

  For test purposes, wrap die() in an overridable method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

  →protected getStringTranslation() -> \Drupal\Core\StringTranslation\TranslationInterface

  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

'read-only' => boolTRUE

'provider' => string(8) "taxonomy"

'field_name' => string(11) "revision_id"

'entity_type' => string(13) "taxonomy_term"

'bundle' => NULL

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 is removed from 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 is removed from drupal:9.0.0. Use
\Drupal\Core\TypedData\ListDataDefinition::getClass() instead.

Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643

• contents
• Available methods (41)

• protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition(7) *RECURSION*

  →protected definition -> array(2)

  'type' => string(19) "field_item:language"

  'settings' => array(0)

  protected typedDataManager -> NULL

• →public static create($field_definition) -> static

  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

  →public static createFromDataType($data_type)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

  →public __construct(array $values = array())

  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

  →public __sleep()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355

  →public addConstraint($constraint_name, $options = NULL)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293

  →public getClass()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

  →public getConstraint($constraint_name)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270

  →public getConstraints()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

  →public getDataType()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

  →public getDescription()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

  →public getFieldDefinition()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

  →public getLabel()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

  →public getMainPropertyName()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

  →public getPropertyDefinition($name)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

  →public getPropertyDefinitions()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

  →public getSetting($setting_name)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

  →public getSettings()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

  →public getTypedDataManager() -> \Drupal\Core\TypedData\TypedDataManagerInterface

  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

  →public isComputed()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

  →public isInternal()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365

  →public isList()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

  →public isReadOnly()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

  →public isRequired()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

  →public offsetExists($offset)

  {@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

  →public &offsetGet($offset)

  {@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

  →public offsetSet($offset, $value)

  {@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

  →public offsetUnset($offset)

  {@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

  →public setClass($class) -> static

  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

  →public setComputed($computed) -> static

  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

  →public setConstraints(array $constraints) -> $this

  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

  →public setDataType($type) -> static

  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

  →public setDescription($description) -> static

  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

  →public setFieldDefinition($field_definition)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

  →public setInternal($internal) -> $this

  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

  →public setLabel($label) -> static

  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

  →public setReadOnly($read_only) -> static

  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

  →public setRequired($required) -> static

  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

  →public setSetting($setting_name, $value) -> static

  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

  →public setSettings(array $settings) -> static

  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

  →public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager) -> $this

  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

  →public toArray() -> array

  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

→'label' => Drupal\Core\StringTranslation\TranslatableMarkup(5)

• contents
• Available methods (14)

• protected translatedMarkup -> NULL

  protected options -> array(0)

  protected stringTranslation -> NULL

  protected string -> string(8) "Language"

  protected arguments -> array(0)

• →public __construct($string, array $arguments = array(), array $options = array(), Drupal\Core\StringTranslation\TranslationInterface $string_translation = NULL)

  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

  →public __sleep()

  Magic __sleep() method to avoid serializing the string translator.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

  →public __toString()

  Implements the magic __toString() method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

  →public count() -> int

  Returns the string length.
  
  @return int
  The length of the string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

  →public getArguments() -> mixed[]

  Gets all arguments from this translated string.
  
  @return mixed[]
  The array of arguments.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

  →public getOption($name) -> mixed

  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

  →public getOptions() -> mixed[]

  Gets all options from this translated string.
  
  @return mixed[]
  The array of options.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

  →public getUntranslatedString() -> string

  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

  →public jsonSerialize() -> string

  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

  →public render() -> string

  Renders the object as a string.
  
  @return string
  The translated string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

  →protected static placeholderEscape($value) -> string

  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

  →protected static placeholderFormat($string, array $args) -> string

  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

  →protected _die()

  For test purposes, wrap die() in an overridable method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

  →protected getStringTranslation() -> \Drupal\Core\StringTranslation\TranslationInterface

  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

→'display' => array(2)

→'view' => array(2)

→'options' => array(1)

*DEPTH TOO GREAT*

'configurable' => boolTRUE

→'form' => array(2)

→'options' => array(2)

*DEPTH TOO GREAT*

'configurable' => boolTRUE

'revisionable' => boolTRUE

'translatable' => boolTRUE

→'description' => Drupal\Core\StringTranslation\TranslatableMarkup(5)

• contents
• Available methods (14)

• protected translatedMarkup -> NULL

  protected options -> array(0)

  protected stringTranslation -> NULL

  protected string -> string(23) "The term language code."

  protected arguments -> array(0)

• →public __construct($string, array $arguments = array(), array $options = array(), Drupal\Core\StringTranslation\TranslationInterface $string_translation = NULL)

  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

  →public __sleep()

  Magic __sleep() method to avoid serializing the string translator.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

  →public __toString()

  Implements the magic __toString() method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

  →public count() -> int

  Returns the string length.
  
  @return int
  The length of the string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

  →public getArguments() -> mixed[]

  Gets all arguments from this translated string.
  
  @return mixed[]
  The array of arguments.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

  →public getOption($name) -> mixed

  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

  →public getOptions() -> mixed[]

  Gets all options from this translated string.
  
  @return mixed[]
  The array of options.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

  →public getUntranslatedString() -> string

  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

  →public jsonSerialize() -> string

  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

  →public render() -> string

  Renders the object as a string.
  
  @return string
  The translated string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

  →protected static placeholderEscape($value) -> string

  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

  →protected static placeholderFormat($string, array $args) -> string

  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

  →protected _die()

  For test purposes, wrap die() in an overridable method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

  →protected getStringTranslation() -> \Drupal\Core\StringTranslation\TranslationInterface

  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

'provider' => string(8) "taxonomy"

'field_name' => string(8) "langcode"

'entity_type' => string(13) "taxonomy_term"

'bundle' => NULL

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 is removed from 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 is removed from drupal:9.0.0. Use
\Drupal\Core\TypedData\ListDataDefinition::getClass() instead.

Defined in <ROOT>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:643

• contents
• Available methods (41)

• protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition(7) *RECURSION*

  →protected definition -> array(2)

  'type' => string(27) "field_item:entity_reference"

  →'settings' => array(3)

  'target_type' => string(19) "taxonomy_vocabulary"

  'handler' => string(7) "default"

  'handler_settings' => array(0)

  protected typedDataManager -> NULL

• →public static create($field_definition) -> static

  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

  →public static createFromDataType($data_type)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

  →public __construct(array $values = array())

  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

  →public __sleep()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:355

  →public addConstraint($constraint_name, $options = NULL)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:293

  →public getClass()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

  →public getConstraint($constraint_name)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:270

  →public getConstraints()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

  →public getDataType()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

  →public getDescription()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

  →public getFieldDefinition()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

  →public getLabel()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

  →public getMainPropertyName()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

  →public getPropertyDefinition($name)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

  →public getPropertyDefinitions()

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

  →public getSetting($setting_name)

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

  →public getSettings()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

  →public getTypedDataManager() -> \Drupal\Core\TypedData\TypedDataManagerInterface

  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

  →public isComputed()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

  →public isInternal()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:365

  →public isList()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

  →public isReadOnly()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

  →public isRequired()

  {@inheritdoc}
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <ROOT>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

  →public offsetExists($offset)

  {@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

  →public &offsetGet($offset)

  {@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

  →public offsetSet($offset, $value)

  {@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

  →public offsetUnset($offset)

  {@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

  →public setClass($class) -> static

  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

  →public setComputed($computed) -> static

  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

  →public setConstraints(array $constraints) -> $this

  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

  →public setDataType($type) -> static

  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

  →public setDescription($description) -> static

  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

  →public setFieldDefinition($field_definition)

  {@inheritdoc}
  
  Defined in <ROOT>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

  →public setInternal($internal) -> $this

  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

  →public setLabel($label) -> static

  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

  →public setReadOnly($read_only) -> static

  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

  →public setRequired($required) -> static

  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

  →public setSetting($setting_name, $value) -> static

  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

  →public setSettings(array $settings) -> static

  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

  →public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager) -> $this

  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

  →public toArray() -> array

  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

→'label' => Drupal\Core\StringTranslation\TranslatableMarkup(5)

• contents
• Available methods (14)

• protected translatedMarkup -> NULL

  protected options -> array(0)

  protected stringTranslation -> NULL

  protected string -> string(10) "Vocabulary"

  protected arguments -> array(0)

• →public __construct($string, array $arguments = array(), array $options = array(), Drupal\Core\StringTranslation\TranslationInterface $string_translation = NULL)

  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

  →public __sleep()

  Magic __sleep() method to avoid serializing the string translator.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

  →public __toString()

  Implements the magic __toString() method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

  →public count() -> int

  Returns the string length.
  
  @return int
  The length of the string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

  →public getArguments() -> mixed[]

  Gets all arguments from this translated string.
  
  @return mixed[]
  The array of arguments.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

  →public getOption($name) -> mixed

  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

  →public getOptions() -> mixed[]

  Gets all options from this translated string.
  
  @return mixed[]
  The array of options.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

  →public getUntranslatedString() -> string

  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

  →public jsonSerialize() -> string

  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

  →public render() -> string

  Renders the object as a string.
  
  @return string
  The translated string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

  →protected static placeholderEscape($value) -> string

  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

  →protected static placeholderFormat($string, array $args) -> string

  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

  →protected _die()

  For test purposes, wrap die() in an overridable method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

  →protected getStringTranslation() -> \Drupal\Core\StringTranslation\TranslationInterface

  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

'required' => boolTRUE

'read-only' => boolTRUE

→'description' => Drupal\Core\StringTranslation\TranslatableMarkup(5)

• contents
• Available methods (14)

• protected translatedMarkup -> NULL

  protected options -> array(0)

  protected stringTranslation -> NULL

  protected string -> string(45) "The vocabulary to which the term is assigned."

  protected arguments -> array(0)

• →public __construct($string, array $arguments = array(), array $options = array(), Drupal\Core\StringTranslation\TranslationInterface $string_translation = NULL)

  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

  →public __sleep()

  Magic __sleep() method to avoid serializing the string translator.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

  →public __toString()

  Implements the magic __toString() method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

  →public count() -> int

  Returns the string length.
  
  @return int
  The length of the string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

  →public getArguments() -> mixed[]

  Gets all arguments from this translated string.
  
  @return mixed[]
  The array of arguments.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

  →public getOption($name) -> mixed

  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

  →public getOptions() -> mixed[]

  Gets all options from this translated string.
  
  @return mixed[]
  The array of options.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

  →public getUntranslatedString() -> string

  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

  →public jsonSerialize() -> string

  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

  →public render() -> string

  Renders the object as a string.
  
  @return string
  The translated string.
  
  Defined in <ROOT>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

  →protected static placeholderEscape($value) -> string

  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

  →protected static placeholderFormat($string, array $args) -> string

  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

  →protected _die()

  For test purposes, wrap die() in an overridable method.
  
  Defined in <ROOT>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

  →protected getStringTranslation() -> \Drupal\Core\StringTranslation\TranslationInterface

  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

'provider' => string(8) "taxonomy"

'field_name' => string(3) "vid"

'entity_type' => string(13) "taxonomy_term"

'bundle' => NULL