• Properties (7)
• Methods (89)
• Static methods (9)
• Class constants (1)

• protected definition -> array (9)

  label => Drupal\Core\StringTranslation\TranslatableMarkup#3200 (5)

  • Properties (5)
  • Methods (12)
  • Static methods (2)
  • toString

  • protected string -> string (9) "URL alias"

    protected arguments -> array (0)

    protected translatedMarkup -> null

    protected options -> array (0)

    protected stringTranslation -> null

  • public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.

    /**
     * Constructs a new class instance.
     *
     * When possible, use the
     * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
     * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
     * directly.
     *
     * Calling the trait's t() method or instantiating a new TranslatableMarkup
     * object serves two purposes:
     * - At run-time it translates user-visible text into the appropriate
     *   language.
     * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
     *   the first argument (the string to be translated) to the database of
     *   strings that need translation. These strings are expected to be in
     *   English, so the first argument should always be in English.
     * To allow the site to be localized, it is important that all human-readable
     * text that will be displayed on the site or sent to a user is made available
     * in one of the ways supported by the
     * @link https://www.drupal.org/node/322729 Localization API @endlink.
     * See the @link https://www.drupal.org/node/322729 Localization API @endlink
     * pages for more information, including recommendations on how to break up or
     * not break up strings for translation.
     *
     * @section sec_translating_vars Translating Variables
     * $string should always be an English literal string.
     *
     * $string should never contain a variable, such as:
     * @code
     * new TranslatableMarkup($text)
     * @endcode
     * There are several reasons for this:
     * - Using a variable for $string that is user input is a security risk.
     * - Using a variable for $string that has even guaranteed safe text (for
     *   example, user interface text provided literally in code), will not be
     *   picked up by the localization static text processor. (The parameter could
     *   be a variable if the entire string in $text has been passed into t() or
     *   new TranslatableMarkup() elsewhere as the first argument, but that
     *   strategy is not recommended.)
     *
     * It is especially important never to call new TranslatableMarkup($user_text)
     * or t($user_text) where $user_text is some text that a user entered -- doing
     * that can lead to cross-site scripting and other security problems. However,
     * you can use variable substitution in your string, to put variable text such
     * as user names or link URLs into translated text. Variable substitution
     * looks like this:
     * @code
     * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
     * @endcode
     * Basically, you can put placeholders like @name into your string, and the
     * method will substitute the sanitized values at translation time. (See the
     * Localization API pages referenced above and the documentation of
     * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
     * for details about how to safely and correctly define variables in your
     * string.) Translators can then rearrange the string as necessary for the
     * language (e.g., in Spanish, it might be "blog de @name").
     *
     * @param string $string
     *   A string containing the English text to translate.
     * @param array $arguments
     *   (optional) An associative array of replacements to make after
     *   translation. Based on the first character of the key, the value is
     *   escaped and/or themed. See
     *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
     *   details.
     * @param array $options
     *   (optional) An associative array of additional options, with the following
     *   elements:
     *   - 'langcode' (defaults to the current language): A language code, to
     *     translate to a language other than what is used to display the page.
     *   - 'context' (defaults to the empty context): The context the source
     *     string belongs to.
     * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
     *   (optional) The string translation service.
     *
     * @throws \InvalidArgumentException
     *   Exception thrown when $string is not a string.
     *
     * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
     * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
     *
     * @ingroup sanitization
     */
    
    Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

    public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

    /**
     * Gets the untranslated string value stored in this translated string.
     *
     * @return string
     *   The string stored in this wrapper.
     */
    
    Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

    public getOption($name): mixed Gets a specific option from this translated string.

    /**
     * Gets a specific option from this translated string.
     *
     * @param string $name
     *   Option name.
     *
     * @return mixed
     *   The value of this option or empty string of option is not set.
     */
    
    Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

    public getOptions(): mixed[] Gets all options from this translated string.

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

    public getArguments(): mixed[] Gets all arguments from this translated string.

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

    public render(): string Renders the object as a string.

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

    public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

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

    protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

    /**
     * Gets the string translation service.
     *
     * @return \Drupal\Core\StringTranslation\TranslationInterface
     *   The string translation service.
     */
    
    Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

    public count(): int Returns the string length.

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

    public __toString(): string Implements the magic __toString() method.

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

    public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

    /**
     * Returns a representation of the object for use in JSON serialization.
     *
     * @return string
     *   The safe string content.
     */
    
    Inherited from Drupal\Component\Render\FormattableMarkup
    Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

    protected _die() For test purposes, wrap die() in an overridable method.

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

  • protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

    /**
     * Replaces placeholders in a string with values.
     *
     * For convenience examples are listed here. Refer to the parameter
     * description for $args for details of the placeholders "@", "%", and ":".
     *
     * Secure examples.
     * @code
     * // Return the HTML string "Prefix $some_variable".
     * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
     * // Convert an object to a sanitized string.
     * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
     * // Wrap $some_variable in an <em> tag.
     * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
     * // The following are using the : placeholder inside an HTML tag.
     * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
     * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
     * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
     * // Use a : placeholder inside an HTML tag.
     * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
     * @endcode
     * The above are typical examples of using the placeholders correctly.
     *
     * Insecure examples.
     * @code
     * // The following are using the @ placeholder inside an HTML tag.
     * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
     * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
     * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
     * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
     * // Implicitly convert an object to a string, which is not sanitized.
     * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
     * @endcode
     * These are the more common mistakes that can be made. Make sure that your
     * site is not using any insecure usages of these placeholders.
     *
     * @param string $string
     *   A string containing placeholders. The string itself is expected to be
     *   safe and correct HTML. Any unsafe content must be in $args and inserted
     *   via placeholders. It is insecure to use the @ or % placeholders within
     *   the "<"  and ">" of an HTML tag.
     * @param array $args
     *   An associative array of replacements. Each array key should be the same
     *   as a placeholder in $string. The corresponding value should be a string
     *   or an object that implements \Drupal\Component\Render\MarkupInterface.
     *   The args[] value replaces the placeholder in $string. Sanitization and
     *   formatting will be done before replacement. The type of sanitization
     *   and formatting depends on the first character of the key:
     *   - @variable: Use as the default choice for anything displayed on the
     *     site. Do not use within the "<" and ">" of an HTML tag, such as in
     *     HTML attribute values. Doing so is a security risk.
     *   - %variable: Use when @variable would be appropriate, but you want the
     *     placeholder value to be wrapped in an <em> tag with a placeholder
     *     class. As with @variable, do not use within the "<" and ">" of an HTML
     *     tag, such as in HTML attribute values. Doing so is a security risk.
     *   - :variable: Use when the return value is to be used as a URL value of an
     *     HTML attribute. Only the "href" attribute is supported. The return
     *     value is escaped with
     *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
     *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
     *     using the "href" attribute, ensuring the value is always wrapped in
     *     quotes.
     *
     * @return string
     *   A formatted HTML string with the placeholders replaced.
     *
     * @ingroup sanitization
     *
     * @see \Drupal\Core\StringTranslation\TranslatableMarkup
     * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
     * @see \Drupal\Component\Utility\Html::escape()
     * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
     * @see \Drupal\Core\Url::fromUri()
     */
    
    Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

    protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

    /**
     * Escapes a placeholder replacement value if needed.
     *
     * @param string|\Drupal\Component\Render\MarkupInterface $value
     *   A placeholder replacement value.
     *
     * @return string
     *   The properly escaped replacement value.
     */
    
    Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

  • label string (12) "Alias de URL"

  description => Drupal\Core\StringTranslation\TranslatableMarkup#3201 (5)

  • Properties (5)
  • Methods (12)
  • Static methods (2)
  • toString

  • protected string -> string (29) "An alias used with this path."

    protected arguments -> array (0)

    protected translatedMarkup -> null

    protected options -> array (0)

    protected stringTranslation -> null

  • public __construct($string, array $arguments = array(), array $options = array(), ?Drupal\Core\StringTranslation\TranslationInterface $string_translation = null) Constructs a new class instance.

    /**
     * Constructs a new class instance.
     *
     * When possible, use the
     * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
     * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
     * directly.
     *
     * Calling the trait's t() method or instantiating a new TranslatableMarkup
     * object serves two purposes:
     * - At run-time it translates user-visible text into the appropriate
     *   language.
     * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
     *   the first argument (the string to be translated) to the database of
     *   strings that need translation. These strings are expected to be in
     *   English, so the first argument should always be in English.
     * To allow the site to be localized, it is important that all human-readable
     * text that will be displayed on the site or sent to a user is made available
     * in one of the ways supported by the
     * @link https://www.drupal.org/node/322729 Localization API @endlink.
     * See the @link https://www.drupal.org/node/322729 Localization API @endlink
     * pages for more information, including recommendations on how to break up or
     * not break up strings for translation.
     *
     * @section sec_translating_vars Translating Variables
     * $string should always be an English literal string.
     *
     * $string should never contain a variable, such as:
     * @code
     * new TranslatableMarkup($text)
     * @endcode
     * There are several reasons for this:
     * - Using a variable for $string that is user input is a security risk.
     * - Using a variable for $string that has even guaranteed safe text (for
     *   example, user interface text provided literally in code), will not be
     *   picked up by the localization static text processor. (The parameter could
     *   be a variable if the entire string in $text has been passed into t() or
     *   new TranslatableMarkup() elsewhere as the first argument, but that
     *   strategy is not recommended.)
     *
     * It is especially important never to call new TranslatableMarkup($user_text)
     * or t($user_text) where $user_text is some text that a user entered -- doing
     * that can lead to cross-site scripting and other security problems. However,
     * you can use variable substitution in your string, to put variable text such
     * as user names or link URLs into translated text. Variable substitution
     * looks like this:
     * @code
     * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
     * @endcode
     * Basically, you can put placeholders like @name into your string, and the
     * method will substitute the sanitized values at translation time. (See the
     * Localization API pages referenced above and the documentation of
     * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
     * for details about how to safely and correctly define variables in your
     * string.) Translators can then rearrange the string as necessary for the
     * language (e.g., in Spanish, it might be "blog de @name").
     *
     * @param string $string
     *   A string containing the English text to translate.
     * @param array $arguments
     *   (optional) An associative array of replacements to make after
     *   translation. Based on the first character of the key, the value is
     *   escaped and/or themed. See
     *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
     *   details.
     * @param array $options
     *   (optional) An associative array of additional options, with the following
     *   elements:
     *   - 'langcode' (defaults to the current language): A language code, to
     *     translate to a language other than what is used to display the page.
     *   - 'context' (defaults to the empty context): The context the source
     *     string belongs to.
     * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
     *   (optional) The string translation service.
     *
     * @throws \InvalidArgumentException
     *   Exception thrown when $string is not a string.
     *
     * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
     * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
     *
     * @ingroup sanitization
     */
    
    Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

    public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

    /**
     * Gets the untranslated string value stored in this translated string.
     *
     * @return string
     *   The string stored in this wrapper.
     */
    
    Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

    public getOption($name): mixed Gets a specific option from this translated string.

    /**
     * Gets a specific option from this translated string.
     *
     * @param string $name
     *   Option name.
     *
     * @return mixed
     *   The value of this option or empty string of option is not set.
     */
    
    Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

    public getOptions(): mixed[] Gets all options from this translated string.

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

    public getArguments(): mixed[] Gets all arguments from this translated string.

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

    public render(): string Renders the object as a string.

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

    public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

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

    protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

    /**
     * Gets the string translation service.
     *
     * @return \Drupal\Core\StringTranslation\TranslationInterface
     *   The string translation service.
     */
    
    Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

    public count(): int Returns the string length.

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

    public __toString(): string Implements the magic __toString() method.

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

    public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

    /**
     * Returns a representation of the object for use in JSON serialization.
     *
     * @return string
     *   The safe string content.
     */
    
    Inherited from Drupal\Component\Render\FormattableMarkup
    Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

    protected _die() For test purposes, wrap die() in an overridable method.

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

  • protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

    /**
     * Replaces placeholders in a string with values.
     *
     * For convenience examples are listed here. Refer to the parameter
     * description for $args for details of the placeholders "@", "%", and ":".
     *
     * Secure examples.
     * @code
     * // Return the HTML string "Prefix $some_variable".
     * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
     * // Convert an object to a sanitized string.
     * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
     * // Wrap $some_variable in an <em> tag.
     * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
     * // The following are using the : placeholder inside an HTML tag.
     * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
     * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
     * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
     * // Use a : placeholder inside an HTML tag.
     * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
     * @endcode
     * The above are typical examples of using the placeholders correctly.
     *
     * Insecure examples.
     * @code
     * // The following are using the @ placeholder inside an HTML tag.
     * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
     * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
     * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
     * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
     * // Implicitly convert an object to a string, which is not sanitized.
     * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
     * @endcode
     * These are the more common mistakes that can be made. Make sure that your
     * site is not using any insecure usages of these placeholders.
     *
     * @param string $string
     *   A string containing placeholders. The string itself is expected to be
     *   safe and correct HTML. Any unsafe content must be in $args and inserted
     *   via placeholders. It is insecure to use the @ or % placeholders within
     *   the "<"  and ">" of an HTML tag.
     * @param array $args
     *   An associative array of replacements. Each array key should be the same
     *   as a placeholder in $string. The corresponding value should be a string
     *   or an object that implements \Drupal\Component\Render\MarkupInterface.
     *   The args[] value replaces the placeholder in $string. Sanitization and
     *   formatting will be done before replacement. The type of sanitization
     *   and formatting depends on the first character of the key:
     *   - @variable: Use as the default choice for anything displayed on the
     *     site. Do not use within the "<" and ">" of an HTML tag, such as in
     *     HTML attribute values. Doing so is a security risk.
     *   - %variable: Use when @variable would be appropriate, but you want the
     *     placeholder value to be wrapped in an <em> tag with a placeholder
     *     class. As with @variable, do not use within the "<" and ">" of an HTML
     *     tag, such as in HTML attribute values. Doing so is a security risk.
     *   - :variable: Use when the return value is to be used as a URL value of an
     *     HTML attribute. Only the "href" attribute is supported. The return
     *     value is escaped with
     *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
     *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
     *     using the "href" attribute, ensuring the value is always wrapped in
     *     quotes.
     *
     * @return string
     *   A formatted HTML string with the placeholders replaced.
     *
     * @ingroup sanitization
     *
     * @see \Drupal\Core\StringTranslation\TranslatableMarkup
     * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
     * @see \Drupal\Component\Utility\Html::escape()
     * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
     * @see \Drupal\Core\Url::fromUri()
     */
    
    Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

    protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

    /**
     * Escapes a placeholder replacement value if needed.
     *
     * @param string|\Drupal\Component\Render\MarkupInterface $value
     *   A placeholder replacement value.
     *
     * @return string
     *   The properly escaped replacement value.
     */
    
    Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

  • description string (43) "Un alias utilizado con esta ruta de acceso."

  required => boolean true

  revisionable => boolean true

  provider => string (10) "path_alias"

  field_name => string (5) "alias"

  entity_type => string (10) "path_alias"

  bundle => null

  display => array (1)

  form => array (1)

  options => array (3)

  type => string (16) "string_textfield"

  weight => integer 10

  settings => array (1) Depth Limit

  protected typedDataManager -> null

  protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#3202 (3)

  • Properties (3)
  • Methods (39)
  • Static methods (4)

  • protected definition -> array (3)

    type => string (17) "field_item:string"

    settings => array (3)

    max_length => integer 255

    is_ascii => boolean false

    case_sensitive => boolean false

    constraints => array (1)

    ComplexData => array (1)

    value => array (1) Depth Limit

    protected typedDataManager -> null

    protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#3199 Recursion

  • public getPropertyDefinition($name) {@inheritdoc}

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

    public getPropertyDefinitions() {@inheritdoc}

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

    public getMainPropertyName() {@inheritdoc}

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

    public getFieldDefinition() {@inheritdoc}

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

    public setFieldDefinition($field_definition) {@inheritdoc}

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

    public getLabel(): string Gets the label of the field type.

    /**
     * Gets the label of the field type.
     *
     * If the label hasn't been set, then fall back to the label of the
     * typed data definition.
     *
     * @return string
     *   The label of the field type.
     *
     * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
     */
    
    Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

    public __construct(array $values = array()) Constructs a new data definition object.

    /**
     * Constructs a new data definition object.
     *
     * @param array $values
     *   (optional) If given, an array of initial values to set on the definition.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

    public getDataType() {@inheritdoc}

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

    public setDataType($type): static Sets the data type.

    /**
     * Sets the data type.
     *
     * @param string $type
     *   The data type to set.
     *
     * @return static
     *   The object itself for chaining.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

    public setLabel($label): static Sets the human-readable label.

    /**
     * Sets the human-readable label.
     *
     * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
     *   The label to set.
     *
     * @return static
     *   The object itself for chaining.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

    public getDescription() {@inheritdoc}

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

    public setDescription($description): static Sets the human-readable description.

    /**
     * Sets the human-readable description.
     *
     * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
     *   The description to set.
     *
     * @return static
     *   The object itself for chaining.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

    public isList() {@inheritdoc}

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

    public isReadOnly() {@inheritdoc}

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

    public setReadOnly($read_only): static Sets whether the data is read-only.

    /**
     * Sets whether the data is read-only.
     *
     * @param bool $read_only
     *   Whether the data is read-only.
     *
     * @return static
     *   The object itself for chaining.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

    public isComputed() {@inheritdoc}

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

    public setComputed($computed): static Sets whether the data is computed.

    /**
     * Sets whether the data is computed.
     *
     * @param bool $computed
     *   Whether the data is computed.
     *
     * @return static
     *   The object itself for chaining.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

    public isRequired() {@inheritdoc}

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

    public setRequired($required): static Sets whether the data is required.

    /**
     * Sets whether the data is required.
     *
     * @param bool $required
     *   Whether the data is required.
     *
     * @return static
     *   The object itself for chaining.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

    public getClass() {@inheritdoc}

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

    public setClass($class): static Sets the class used for creating the typed data object.

    /**
     * Sets the class used for creating the typed data object.
     *
     * @param string|null $class
     *   The class to use.
     *
     * @return static
     *   The object itself for chaining.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

    public getSettings() {@inheritdoc}

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

    public setSettings(array $settings): static Sets the array of settings, as required by the used class.

    /**
     * Sets the array of settings, as required by the used class.
     *
     * @param array $settings
     *   The array of settings.
     *
     * @return static
     *   The object itself for chaining.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

    public getSetting($setting_name) {@inheritdoc}

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

    public setSetting($setting_name, $value): static Sets a definition setting.

    /**
     * Sets a definition setting.
     *
     * @param string $setting_name
     *   The definition setting to set.
     * @param mixed $value
     *   The value to set.
     *
     * @return static
     *   The object itself for chaining.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

    public getConstraints() {@inheritdoc}

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

    public getConstraint($constraint_name) {@inheritdoc}

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

    public setConstraints(array $constraints): $this Sets an array of validation constraints.

    /**
     * Sets an array of validation constraints.
     *
     * @param array $constraints
     *   An array of validation constraint definitions, keyed by constraint name.
     *   Each constraint definition can be used for instantiating
     *   \Symfony\Component\Validator\Constraint objects.
     *
     * @return $this
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

    public addConstraint($constraint_name, $options = null) {@inheritdoc}

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

    public offsetExists($offset): bool {@inheritdoc}

    /**
     * {@inheritdoc}
     *
     * This is for BC support only.
     *
     * @todo Remove in https://www.drupal.org/node/1928868.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

    public & offsetGet($offset): mixed {@inheritdoc}

    /**
     * {@inheritdoc}
     *
     * This is for BC support only.
     *
     * @todo Remove in https://www.drupal.org/node/1928868.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

    public offsetSet($offset, $value): void {@inheritdoc}

    /**
     * {@inheritdoc}
     *
     * This is for BC support only.
     *
     * @todo Remove in https://www.drupal.org/node/1928868.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

    public offsetUnset($offset): void {@inheritdoc}

    /**
     * {@inheritdoc}
     *
     * This is for BC support only.
     *
     * @todo Remove in https://www.drupal.org/node/1928868.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

    public toArray(): array Returns all definition values as array.

    /**
     * Returns all definition values as array.
     *
     * @return array
     *   The array holding values for all definition keys.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

    public __sleep(): array {@inheritdoc}

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

    public isInternal() {@inheritdoc}

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

    public setInternal($internal): $this Sets the whether the data value should be internal.

    /**
     * Sets the whether the data value should be internal.
     *
     * @param bool $internal
     *   Whether the data value should be internal.
     *
     * @return $this
     *
     * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

    public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

    /**
     * Sets the typed data manager.
     *
     * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
     *   The typed data manager.
     *
     * @return $this
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

    public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

    /**
     * Gets the typed data manager.
     *
     * @return \Drupal\Core\TypedData\TypedDataManagerInterface
     *   The typed data manager.
     */
    
    Inherited from Drupal\Core\TypedData\DataDefinition
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

  • public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

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

    public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

    /**
     * Creates a new field item definition.
     *
     * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
     *   The field definition the item definition belongs to.
     *
     * @return static
     */
    
    Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

    public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

    /**
     * Creates a new data definition.
     *
     * @param string $type
     *   The data type of the data; e.g., 'string', 'integer' or 'any'.
     *
     * @return static
     *   A new DataDefinition object.
     */
    
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

    public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

    /**
     * {@inheritdoc}
     */
    
    Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

  protected type -> string (6) "string"

  protected propertyDefinitions -> null

  protected schema -> null

  protected indexes -> array (0)

• public getName() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

  public setName($name): static Sets the field name.

  /**
   * Sets the field name.
   *
   * @param string $name
   *   The field name to set.
   *
   * @return static
   *   The object itself for chaining.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

  public getType() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

  public getSettings() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

  public setSettings(array $settings) {@inheritdoc}

  /**
   * {@inheritdoc}
   *
   * Note that the method does not unset existing settings not specified in the
   * incoming $settings array.
   *
   * For example:
   * @code
   *   // Given these are the default settings.
   *   $field_definition->getSettings() === [
   *     'fruit' => 'apple',
   *     'season' => 'summer',
   *   ];
   *   // Change only the 'fruit' setting.
   *   $field_definition->setSettings(['fruit' => 'banana']);
   *   // The 'season' setting persists unchanged.
   *   $field_definition->getSettings() === [
   *     'fruit' => 'banana',
   *     'season' => 'summer',
   *   ];
   * @endcode
   *
   * For clarity, it is preferred to use setSetting() if not all available
   * settings are supplied.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

  public getSetting($setting_name) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

  public setSetting($setting_name, $value) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

  public getProvider() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

  public setProvider($provider): $this Sets the name of the provider of this field.

  /**
   * Sets the name of the provider of this field.
   *
   * @param string $provider
   *   The provider name to set.
   *
   * @return $this
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

  public isTranslatable() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

  public setTranslatable($translatable): $this Sets whether the field is translatable.

  /**
   * Sets whether the field is translatable.
   *
   * @param bool $translatable
   *   Whether the field is translatable.
   *
   * @return $this
   *   The object itself for chaining.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

  public isRevisionable() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

  public setRevisionable($revisionable): $this Sets whether the field is revisionable.

  /**
   * Sets whether the field is revisionable.
   *
   * @param bool $revisionable
   *   Whether the field is revisionable.
   *
   * @return $this
   *   The object itself for chaining.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

  public getCardinality() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

  public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

  /**
   * Sets the maximum number of items allowed for the field.
   *
   * Possible values are positive integers or
   * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
   *
   * Note that if the entity type that this base field is attached to is
   * revisionable and the field has a cardinality higher than 1, the field is
   * considered revisionable by default.
   *
   * @param int $cardinality
   *   The field cardinality.
   *
   * @return $this
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

  public isMultiple() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

  public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

  /**
   * Sets constraints for a given field item property.
   *
   * Note: this overwrites any existing property constraints. If you need to
   * add to the existing constraints, use
   * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
   *
   * @param string $name
   *   The name of the property to set constraints for.
   * @param array $constraints
   *   The constraints to set.
   *
   * @return static
   *   The object itself for chaining.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

  public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

  /**
   * Adds constraints for a given field item property.
   *
   * Adds a constraint to a property of a base field item. e.g.
   * @code
   * // Limit the field item's value property to the range 0 through 10.
   * // e.g. $node->size->value.
   * $field->addPropertyConstraints('value', [
   *   'Range' => [
   *     'min' => 0,
   *     'max' => 10,
   *   ]
   * ]);
   * @endcode
   *
   * If you want to add a validation constraint that applies to the
   * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
   * instead.
   *
   * Note: passing a new set of options for an existing property constraint will
   * overwrite with the new options.
   *
   * @param string $name
   *   The name of the property to set constraints for.
   * @param array $constraints
   *   The constraints to set.
   *
   * @return static
   *   The object itself for chaining.
   *
   * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

  public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

  /**
   * Sets the display options for the field in forms or rendered entities.
   *
   * This enables generic rendering of the field with widgets / formatters,
   * including automated support for "In place editing", and with optional
   * configurability in the "Manage display" / "Manage form display" UI screens.
   *
   * Unless this method is called, the field remains invisible (or requires
   * ad-hoc rendering logic).
   *
   * @param string $display_context
   *   The display context. Either 'view' or 'form'.
   * @param array $options
   *   An array of display options. Refer to
   *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
   *   a list of supported keys. The options should include at least a 'weight',
   *   or specify 'region' = 'hidden'. The 'default_widget' /
   *   'default_formatter' for the field type will be used if no 'type' is
   *   specified.
   *
   * @return static
   *   The object itself for chaining.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

  public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

  /**
   * Sets whether the display for the field can be configured.
   *
   * @param string $display_context
   *   The display context. Either 'view' or 'form'.
   * @param bool $configurable
   *   Whether the display options can be configured (e.g., via the "Manage
   *   display" / "Manage form display" UI screens). If TRUE, the options
   *   specified via getDisplayOptions() act as defaults.
   *
   * @return static
   *   The object itself for chaining.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

  public getDisplayOptions($display_context) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

  public isDisplayConfigurable($display_context) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

  public getDefaultValueLiteral() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

  public getDefaultValueCallback() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

  public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

  public setDefaultValue($value) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

  public setDefaultValueCallback($callback) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

  public getInitialValue(): array Returns the initial value for the field.

  /**
   * Returns the initial value for the field.
   *
   * @return array
   *   The initial value for the field, as a numerically indexed array of items,
   *   each item being a property/value array. An empty array when there is no
   *   default value.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

  public setInitialValue($value): $this Sets an initial value for the field.

  /**
   * Sets an initial value for the field.
   *
   * @param mixed $value
   *   The initial value for the field. This can be either:
   *   - a literal, in which case it will be assigned to the first property of
   *     the first item;
   *   - a numerically indexed array of items, each item being a property/value
   *     array;
   *   - a non-numerically indexed array, in which case the array is assumed to
   *     be a property/value array and used as the first item;
   *   - an empty array for no initial value.
   *
   * @return $this
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

  public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

  /**
   * Returns the name of the field that will be used for getting initial values.
   *
   * @return string|null
   *   The field name.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

  public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

  /**
   * Sets a field that will be used for getting initial values.
   *
   * @param string $field_name
   *   The name of the field that will be used for getting initial values.
   * @param mixed $default_value
   *   (optional) The default value for the field, in case the inherited value
   *   is NULL. This can be either:
   *   - a literal, in which case it will be assigned to the first property of
   *     the first item;
   *   - a numerically indexed array of items, each item being a property/value
   *     array;
   *   - a non-numerically indexed array, in which case the array is assumed to
   *     be a property/value array and used as the first item;
   *   - an empty array for no initial value.
   *   If the field being added is required or an entity key, it is recommended
   *   to provide a default value.
   *
   * @return $this
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

  public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

  public getPropertyDefinition($name) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

  public getPropertyDefinitions() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

  public getPropertyNames() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

  public getMainPropertyName() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

  public __sleep(): array {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

  public getTargetEntityTypeId() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

  public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

  /**
   * Sets the ID of the type of the entity this field is attached to.
   *
   * @param string $entity_type_id
   *   The name of the target entity type to set.
   *
   * @return $this
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

  public getTargetBundle() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

  public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

  /**
   * Sets the bundle this field is defined for.
   *
   * @param string|null $bundle
   *   The bundle, or NULL if the field is not bundle-specific.
   *
   * @return $this
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

  public getSchema() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

  public getColumns() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

  public hasCustomStorage() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

  public isBaseField() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

  public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

  /**
   * Sets the storage behavior for this field.
   *
   * @param bool $custom_storage
   *   Pass FALSE if the storage takes care of storing the field,
   *   TRUE otherwise.
   *
   * @return $this
   *
   * @throws \LogicException
   *   Thrown if custom storage is to be set to FALSE for a computed field.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

  public getFieldStorageDefinition() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

  public getUniqueStorageIdentifier() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

  public getUniqueIdentifier() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

  public isDeleted() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

  public setDeleted($deleted): $this Sets whether the field storage is deleted.

  /**
   * Sets whether the field storage is deleted.
   *
   * @param bool $deleted
   *   Whether the field storage is deleted.
   *
   * @return $this
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

  public getConfig($bundle) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

  public isStorageRequired() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

  public setStorageRequired($required): static Sets whether the field storage is required.

  /**
   * Sets whether the field storage is required.
   *
   * @param bool $required
   *   Whether the field storage is required.
   *
   * @return static
   *   The object itself for chaining.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

  public __clone() Magic method: Implements a deep clone.

  /**
   * Magic method: Implements a deep clone.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

  public isInternal() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

  public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Inherited from Drupal\Core\TypedData\ListDataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

  public getDataType() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Inherited from Drupal\Core\TypedData\ListDataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

  public setDataType($type) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Inherited from Drupal\Core\TypedData\ListDataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

  public getClass() {@inheritdoc}

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

  public getItemDefinition() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Inherited from Drupal\Core\TypedData\ListDataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

  public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

  /**
   * Sets the item definition.
   *
   * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
   *   A list item's data definition.
   *
   * @return $this
   */
  
  Inherited from Drupal\Core\TypedData\ListDataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

  public getLabel() {@inheritdoc}

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

  public setLabel($label): static Sets the human-readable label.

  /**
   * Sets the human-readable label.
   *
   * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
   *   The label to set.
   *
   * @return static
   *   The object itself for chaining.
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

  public getDescription() {@inheritdoc}

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

  public setDescription($description): static Sets the human-readable description.

  /**
   * Sets the human-readable description.
   *
   * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
   *   The description to set.
   *
   * @return static
   *   The object itself for chaining.
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

  public isList() {@inheritdoc}

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

  public isReadOnly() {@inheritdoc}

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

  public setReadOnly($read_only): static Sets whether the data is read-only.

  /**
   * Sets whether the data is read-only.
   *
   * @param bool $read_only
   *   Whether the data is read-only.
   *
   * @return static
   *   The object itself for chaining.
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

  public isComputed() {@inheritdoc}

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

  public setComputed($computed): static Sets whether the data is computed.

  /**
   * Sets whether the data is computed.
   *
   * @param bool $computed
   *   Whether the data is computed.
   *
   * @return static
   *   The object itself for chaining.
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

  public isRequired() {@inheritdoc}

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

  public setRequired($required): static Sets whether the data is required.

  /**
   * Sets whether the data is required.
   *
   * @param bool $required
   *   Whether the data is required.
   *
   * @return static
   *   The object itself for chaining.
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

  public setClass($class): static Sets the class used for creating the typed data object.

  /**
   * Sets the class used for creating the typed data object.
   *
   * @param string|null $class
   *   The class to use.
   *
   * @return static
   *   The object itself for chaining.
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

  public getConstraints() {@inheritdoc}

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

  public getConstraint($constraint_name) {@inheritdoc}

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

  public setConstraints(array $constraints): $this Sets an array of validation constraints.

  /**
   * Sets an array of validation constraints.
   *
   * @param array $constraints
   *   An array of validation constraint definitions, keyed by constraint name.
   *   Each constraint definition can be used for instantiating
   *   \Symfony\Component\Validator\Constraint objects.
   *
   * @return $this
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

  public addConstraint($constraint_name, $options = null) {@inheritdoc}

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

  public offsetExists($offset): bool {@inheritdoc}

  /**
   * {@inheritdoc}
   *
   * This is for BC support only.
   *
   * @todo Remove in https://www.drupal.org/node/1928868.
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

  public & offsetGet($offset): mixed {@inheritdoc}

  /**
   * {@inheritdoc}
   *
   * This is for BC support only.
   *
   * @todo Remove in https://www.drupal.org/node/1928868.
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

  public offsetSet($offset, $value): void {@inheritdoc}

  /**
   * {@inheritdoc}
   *
   * This is for BC support only.
   *
   * @todo Remove in https://www.drupal.org/node/1928868.
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

  public offsetUnset($offset): void {@inheritdoc}

  /**
   * {@inheritdoc}
   *
   * This is for BC support only.
   *
   * @todo Remove in https://www.drupal.org/node/1928868.
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

  public toArray(): array Returns all definition values as array.

  /**
   * Returns all definition values as array.
   *
   * @return array
   *   The array holding values for all definition keys.
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

  public setInternal($internal): $this Sets the whether the data value should be internal.

  /**
   * Sets the whether the data value should be internal.
   *
   * @param bool $internal
   *   Whether the data value should be internal.
   *
   * @return $this
   *
   * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

  public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

  /**
   * Sets the typed data manager.
   *
   * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
   *   The typed data manager.
   *
   * @return $this
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

  public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

  /**
   * Gets the typed data manager.
   *
   * @return \Drupal\Core\TypedData\TypedDataManagerInterface
   *   The typed data manager.
   */
  
  Inherited from Drupal\Core\TypedData\DataDefinition
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

  public getCacheContexts() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

  public getCacheTags() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

  public getCacheMaxAge() {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

• public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

  /**
   * Creates a new field definition.
   *
   * @param string $type
   *   The type of the field.
   *
   * @return static
   *   A new field definition object.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

  public static Drupal\Core\Field\BaseFieldDefinition::createFromFieldStorageDefinition(Drupal\Core\Field\FieldStorageDefinitionInterface $definition): $this Creates a new field definition based upon a field storage definition.

  /**
   * Creates a new field definition based upon a field storage definition.
   *
   * In cases where one needs a field storage definitions to act like full
   * field definitions, this creates a new field definition based upon the
   * (limited) information available. That way it is possible to use the field
   * definition in places where a full field definition is required; e.g., with
   * widgets or formatters.
   *
   * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
   *   The field storage definition to base the new field definition upon.
   *
   * @return $this
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

  public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

  public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33

  protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.

  /**
   * Ensure a field value is transformed into a format keyed by delta.
   *
   * @param mixed $value
   *   The raw field value to normalize.
   * @param string|null $main_property_name
   *   The main field property name.
   *
   * @return array
   *   A field value normalized into a format keyed by delta.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

  public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.

  /**
   * Creates a new list definition.
   *
   * @param string $item_type
   *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
   *
   * @return static
   *   A new List Data Definition object.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26

  public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43

  public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

  /**
   * Creates a new data definition.
   *
   * @param string $type
   *   The data type of the data; e.g., 'string', 'integer' or 'any'.
   *
   * @return static
   *   A new DataDefinition object.
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

  public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

  /**
   * {@inheritdoc}
   */
  
  Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

• public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:45

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:94

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:106

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:116

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:138

/**
 * Renumbers the items in the list.
 *
 * @param int $from_index
 *   Optionally, the index at which to start the renumbering, if it is known
 *   that items before that can safely be skipped (for example, when removing
 *   an item at a given index).
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:158

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:171

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:178

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:186

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:193

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:213

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:233

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:240

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:247

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:254

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:272

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:294

/**
 * Magic method: Implements a deep clone.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:304

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:314

/**
 * Constructs a TypedData object given its definition and context.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   The data definition.
 * @param string $name
 *   (optional) The name of the created property, or NULL if it is the root
 *   of a typed data tree. Defaults to NULL.
 * @param \Drupal\Core\TypedData\TypedDataInterface $parent
 *   (optional) The parent object of the data property, or NULL if it is the
 *   root of a typed data tree. Defaults to NULL.
 *
 * @see \Drupal\Core\TypedData\TypedDataManager::create()
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:339

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46