Devel Load | Zausen Consultoría

$0 Drupal\commerce_product\Entity\Product#2497 (18)

Entity Fields (18)
Properties (31)
Methods (139)
Static methods (17)
Static properties (1)
Class constants (3)
Iterator

product_id -> string (1) "6" $0->product_id->value

uuid -> string (36) "6eb611e5-0c3d-4952-8821-1f90f46f5ffa" $0->uuid->value

langcode -> string (2) "es" $0->langcode->value

type -> string (10) "opcionales" $0->type->target_id

uid -> string (1) "2" $0->uid->target_id

status -> string (1) "1" $0->status->value

stores -> string (1) "1" $0->stores->target_id

title -> string (11) "Extra carga" $0->title->value

variations -> string (1) "5" $0->variations->target_id

default_variation -> string (1) "5" $0->default_variation->target_id

path -> string (2) "es" $0->path->langcode

created -> string (10) "1773827192" $0->created->value

2026-03-18T09:46:32+00:00

changed -> string (10) "1773827345" $0->changed->value

2026-03-18T09:49:05+00:00

default_langcode -> string (1) "1" $0->default_langcode->value

metatag -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8845 (9) $0->metatag

Values (9)
Properties (11)
Methods (72)
Static methods (2)
Iterator

0 => array (2)
$0->metatag->getValue()[0]
tag => string (4) "meta"
$0->metatag->getValue()[0]['tag']
attributes => array (2)
$0->metatag->getValue()[0]['attributes']
name => string (5) "title"
$0->metatag->getValue()[0]['attributes']['name']
content => UTF-8 string (32) "Devel Load | Zausen Consultoría"
$0->metatag->getValue()[0]['attributes']['content']
1 => array (2)
$0->metatag->getValue()[1]
tag => string (4) "link"
$0->metatag->getValue()[1]['tag']
attributes => array (2)
$0->metatag->getValue()[1]['attributes']
rel => string (9) "canonical"
$0->metatag->getValue()[1]['attributes']['rel']
href => string (49) "https://tcq.bitanube.com/devel/commerce_product/6"
$0->metatag->getValue()[1]['attributes']['href']
2 => array (2)
$0->metatag->getValue()[2]
tag => string (4) "meta"
$0->metatag->getValue()[2]['tag']
attributes => array (4)
$0->metatag->getValue()[2]['attributes']
name => string (19) "isAccessibleForFree"
$0->metatag->getValue()[2]['attributes']['name']
content => string (4) "True"
$0->metatag->getValue()[2]['attributes']['content']
group => string (14) "schema_article"
$0->metatag->getValue()[2]['attributes']['group']
schema_metatag => boolean true
$0->metatag->getValue()[2]['attributes']['schema_metatag']
3 => array (2)
$0->metatag->getValue()[3]
tag => string (4) "meta"
$0->metatag->getValue()[3]['tag']
attributes => array (4)
$0->metatag->getValue()[3]['attributes']
name => string (5) "@type"
$0->metatag->getValue()[3]['attributes']['name']
content => string (12) "Organization"
$0->metatag->getValue()[3]['attributes']['content']
group => string (19) "schema_organization"
$0->metatag->getValue()[3]['attributes']['group']
schema_metatag => boolean true
$0->metatag->getValue()[3]['attributes']['schema_metatag']
4 => array (2)
$0->metatag->getValue()[4]
tag => string (4) "meta"
$0->metatag->getValue()[4]['tag']
attributes => array (4)
$0->metatag->getValue()[4]['attributes']
name => string (3) "@id"
$0->metatag->getValue()[4]['attributes']['name']
content => string (25) "https://tcq.bitanube.com/"
$0->metatag->getValue()[4]['attributes']['content']
group => string (19) "schema_organization"
$0->metatag->getValue()[4]['attributes']['group']
schema_metatag => boolean true
$0->metatag->getValue()[4]['attributes']['schema_metatag']
5 => array (2)
$0->metatag->getValue()[5]
tag => string (4) "meta"
$0->metatag->getValue()[5]['tag']
attributes => array (4)
$0->metatag->getValue()[5]['attributes']
name => string (11) "description"
$0->metatag->getValue()[5]['attributes']['name']
content => UTF-8 string (186) "Somos tu aliado estratégico para el crecimiento y la eficiencia de tu empres...
$0->metatag->getValue()[5]['attributes']['content']
Somos tu aliado estratégico para el crecimiento y la eficiencia de tu empresa. Ofrecemos una amplia gama de servicios personalizados para satisfacer todas tus necesidades empresariales.
group => string (19) "schema_organization"
$0->metatag->getValue()[5]['attributes']['group']
schema_metatag => boolean true
$0->metatag->getValue()[5]['attributes']['schema_metatag']
6 => array (2)
$0->metatag->getValue()[6]
tag => string (4) "meta"
$0->metatag->getValue()[6]['tag']
attributes => array (4)
$0->metatag->getValue()[6]['attributes']
name => string (4) "name"
$0->metatag->getValue()[6]['attributes']['name']
content => UTF-8 string (19) "Zausen Consultoría"
$0->metatag->getValue()[6]['attributes']['content']
group => string (19) "schema_organization"
$0->metatag->getValue()[6]['attributes']['group']
schema_metatag => boolean true
$0->metatag->getValue()[6]['attributes']['schema_metatag']
7 => array (2)
$0->metatag->getValue()[7]
tag => string (4) "meta"
$0->metatag->getValue()[7]['tag']
attributes => array (4)
$0->metatag->getValue()[7]['attributes']
name => string (3) "url"
$0->metatag->getValue()[7]['attributes']['name']
content => string (25) "https://tcq.bitanube.com/"
$0->metatag->getValue()[7]['attributes']['content']
group => string (19) "schema_organization"
$0->metatag->getValue()[7]['attributes']['group']
schema_metatag => boolean true
$0->metatag->getValue()[7]['attributes']['schema_metatag']
8 => array (2)
$0->metatag->getValue()[8]
tag => string (4) "meta"
$0->metatag->getValue()[8]['tag']
attributes => array (4)
$0->metatag->getValue()[8]['attributes']
name => string (4) "logo"
$0->metatag->getValue()[8]['attributes']['name']
content => array (5)
$0->metatag->getValue()[8]['attributes']['content']
@type => string (11) "ImageObject"
$0->metatag->getValue()[8]['attributes']['content']['@type']
representativeOfPage => string (5) "False"
$0->metatag->getValue()[8]['attributes']['content']['representativeOfPage']
url => string (35) "/sites/default/files/taxi-logo.avif"
$0->metatag->getValue()[8]['attributes']['content']['url']
width => string (2) "60"
$0->metatag->getValue()[8]['attributes']['content']['width']
height => string (2) "60"
$0->metatag->getValue()[8]['attributes']['content']['height']
group => string (19) "schema_organization"
$0->metatag->getValue()[8]['attributes']['group']
schema_metatag => boolean true
$0->metatag->getValue()[8]['attributes']['schema_metatag']

protected definition -> Drupal\Core\Field\BaseFieldDefinition#2649 (7)

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

protected definition -> array (10)

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

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

protected string -> string (40) "Metatags (Hidden field for JSON support)"

protected arguments -> array (0)

protected translatedMarkup -> string (40) "Metatags (Hidden field for JSON support)"

protected options -> array (0)

protected stringTranslation -> Drupal\Core\StringTranslation\TranslationManager#836 (3)

Properties (3)
Methods (10)

protected translators -> array (2)
30 => array (1) Depth Limit
0 => array (1) Depth Limit
protected sortedTranslators -> array (2)
0 => Drupal\Core\StringTranslation\Translator\CustomStrings#851 Depth Limit
1 => Drupal\locale\LocaleTranslation#464 Depth Limit
protected defaultLangcode -> string (2) "es"

public __construct(Drupal\Core\Language\LanguageDefault $default_language) Constructs a TranslationManager object.

/**
 * Constructs a TranslationManager object.
 *
 * @param \Drupal\Core\Language\LanguageDefault $default_language
 *   The default language.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:52

public addTranslator(Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator, $priority = 0): $this Appends a translation system to the translation chain.

/**
 * Appends a translation system to the translation chain.
 *
 * @param \Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator
 *   The translation interface to be appended to the translation chain.
 * @param int $priority
 *   The priority of the logger being added.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:66

protected sortTranslators(): \Drupal\Core\StringTranslation\Translator\TranslatorInterface[] Sorts translators according to priority.

/**
 * Sorts translators according to priority.
 *
 * @return \Drupal\Core\StringTranslation\Translator\TranslatorInterface[]
 *   A sorted array of translator objects.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79

public getStringTranslation($langcode, $string, $context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87

public translate($string, array $args = array(), array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104

public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112

protected doTranslate($string, array $options = array()): string Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $options
 *   An associative array of additional options, with the following elements:
 *   - 'langcode': The language code to translate to a language other than
 *      what is used to display the page.
 *   - 'context': The context the source string belongs to.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:130

public formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:148

public setDefaultLangcode($langcode) Sets the default langcode.

/**
 * Sets the default langcode.
 *
 * @param string $langcode
 *   A language code.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158

public reset() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:165

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

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

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

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

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

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

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

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

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

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

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

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

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

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

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

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

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

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

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

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

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

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

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

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

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

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

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

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

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

label string (40) "Metatags (Hidden field for JSON support)"

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

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

protected string -> string (38) "The computed meta tags for the entity."

protected arguments -> array (0)

protected translatedMarkup -> string (38) "The computed meta tags for the entity."

protected options -> array (0)

protected stringTranslation -> Drupal\Core\StringTranslation\TranslationManager#836 (3)

Properties (3)
Methods (10)

protected translators -> array (2)
30 => array (1) Depth Limit
0 => array (1) Depth Limit
protected sortedTranslators -> array (2)
0 => Drupal\Core\StringTranslation\Translator\CustomStrings#851 Depth Limit
1 => Drupal\locale\LocaleTranslation#464 Depth Limit
protected defaultLangcode -> string (2) "es"

public __construct(Drupal\Core\Language\LanguageDefault $default_language) Constructs a TranslationManager object.

/**
 * Constructs a TranslationManager object.
 *
 * @param \Drupal\Core\Language\LanguageDefault $default_language
 *   The default language.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:52

public addTranslator(Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator, $priority = 0): $this Appends a translation system to the translation chain.

/**
 * Appends a translation system to the translation chain.
 *
 * @param \Drupal\Core\StringTranslation\Translator\TranslatorInterface $translator
 *   The translation interface to be appended to the translation chain.
 * @param int $priority
 *   The priority of the logger being added.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:66

protected sortTranslators(): \Drupal\Core\StringTranslation\Translator\TranslatorInterface[] Sorts translators according to priority.

/**
 * Sorts translators according to priority.
 *
 * @return \Drupal\Core\StringTranslation\Translator\TranslatorInterface[]
 *   A sorted array of translator objects.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:79

public getStringTranslation($langcode, $string, $context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:87

public translate($string, array $args = array(), array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:104

public translateString(Drupal\Core\StringTranslation\TranslatableMarkup $translated_string) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:112

protected doTranslate($string, array $options = array()): string Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $options
 *   An associative array of additional options, with the following elements:
 *   - 'langcode': The language code to translate to a language other than
 *      what is used to display the page.
 *   - 'context': The context the source string belongs to.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:130

public formatPlural($count, $singular, $plural, array $args = array(), array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:148

public setDefaultLangcode($langcode) Sets the default langcode.

/**
 * Sets the default langcode.
 *
 * @param string $langcode
 *   A language code.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:158

public reset() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslationManager.php:165

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

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

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

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

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

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

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

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

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

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

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

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

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

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

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

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

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

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

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

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

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

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

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

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

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

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

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

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

description string (38) "The computed meta tags for the entity."

computed => boolean true

translatable => boolean true

read-only => boolean true

entity_type => string (16) "commerce_product"

cardinality => integer -1

provider => string (7) "metatag"

field_name => string (7) "metatag"

bundle => null

protected typedDataManager -> null

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

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

protected definition -> array (2)
type => string (27) "field_item:metatag_computed"
settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2649 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

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

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

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

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

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

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

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

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

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

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

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

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

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

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

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

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

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

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

protected type -> string (16) "metatag_computed"

protected propertyDefinitions -> array (2)

tag => Drupal\Core\TypedData\DataDefinition#9287 (2)

Properties (2)
Methods (34)
Static methods (2)

protected definition -> array (3)

type => string (6) "string"

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

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

protected string -> string (3) "Tag"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * 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 (8) "Etiqueta"

required => boolean true

protected typedDataManager -> null

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

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

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

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

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

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

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

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

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

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

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

attributes => Drupal\Core\TypedData\MapDataDefinition#10017 (4)

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

protected definition -> array (3)

type => string (3) "map"

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

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

protected string -> string (4) "Name"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

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

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

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

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

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

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

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

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

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

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

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

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

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

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

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

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

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

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

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

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

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

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

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

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

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

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

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

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

label string (6) "Nombre"

required => boolean true

protected typedDataManager -> null

protected propertyDefinitions -> null

protected mainPropertyName -> null

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setPropertyDefinition($name, ?Drupal\Core\TypedData\DataDefinitionInterface $definition = null): $this Sets the definition of a map property.

/**
 * Sets the definition of a map property.
 *
 * @param string $name
 *   The name of the property to define.
 * @param \Drupal\Core\TypedData\DataDefinitionInterface|null $definition
 *   (optional) The property definition to set, or NULL to unset it.
 *
 * @return $this
 */

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

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setMainPropertyName($name): $this Sets the main property name.

/**
 * Sets the main property name.
 *
 * @param string|null $name
 *   The name of the main property, or NULL if there is none.
 *
 * @return $this
 */

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

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

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

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

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

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

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

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

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

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

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

public static Drupal\Core\TypedData\MapDataDefinition::create($type = 'map'): static Creates a new map definition.

/**
 * Creates a new map definition.
 *
 * @param string $type
 *   (optional) The data type of the map. Defaults to 'map'.
 *
 * @return static
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

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

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

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

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

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

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

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

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

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

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

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

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

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

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

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

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

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

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

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

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

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

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

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

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

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

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

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

/**
 * {@inheritdoc}
 */

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

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

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

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

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

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

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

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

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

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

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

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

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

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

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

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

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

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

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

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

/**
 * Creates a new list definition.
 *
 * @param string $item_type
 *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new List Data Definition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

protected name -> string (7) "metatag"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#8497 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1756 Blacklisted

protected list -> array (9)

0 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#10007 (9)

Properties (9)
Methods (49)
Static methods (18)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 (3)

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

protected definition -> array (2)

type => string (27) "field_item:metatag_computed"

settings => array (0)

protected typedDataManager -> null

protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2649 (7)

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

protected definition -> array (10)
label => Drupal\Core\StringTranslation\TranslatableMarkup#2650 Depth Limit
description => Drupal\Core\StringTranslation\TranslatableMarkup#2651 Depth Limit
computed => boolean true
translatable => boolean true
read-only => boolean true
entity_type => string (16) "commerce_product"
cardinality => integer -1
provider => string (7) "metatag"
field_name => string (7) "metatag"
bundle => null
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 Recursion
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2)
tag => Drupal\Core\TypedData\DataDefinition#9287 Depth Limit
attributes => Drupal\Core\TypedData\MapDataDefinition#10017 Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

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

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

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

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

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

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

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

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

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

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

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

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

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

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

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

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

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

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

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

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

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

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

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

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

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

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

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

/**
 * {@inheritdoc}
 */

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

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

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

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

/**
 * Creates a new list definition.
 *
 * @param string $item_type
 *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new List Data Definition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

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

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

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

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

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

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

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

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

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

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

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

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

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

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

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

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

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

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

protected name -> integer 0

protected parent -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8845 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1756 Blacklisted

protected values -> array (2)

tag => string (4) "meta"

attributes => array (2)

name => string (5) "title"

content => UTF-8 string (32) "Devel Load | Zausen Consultoría"

protected properties -> array (0)

public isEmpty() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:47

public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60

public getEntity() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74

public getLangcode() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88

protected getSettings(): array Returns the array of field settings.

/**
 * Returns the array of field settings.
 *
 * @return array
 *   The array of settings.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98

protected getSetting($setting_name): mixed Returns the value of a field setting.

/**
 * Returns the value of a field setting.
 *
 * @param string $setting_name
 *   The setting name.
 *
 * @return mixed
 *   The setting value.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111

public setValue($values, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118

protected writePropertyValue($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Different to the parent Map class, we avoid creating property objects as
 * far as possible in order to optimize performance. Thus we just update
 * $this->values if no property object has been created yet.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186

public view($display_options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200

public preSave() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208

public postSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218

public deleteRevision() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228

public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233

public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public set($property_name, $value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getProperties($include_computed = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getIterator(): ArrayIterator Retrieves the iterator for the object.

/**
 * Retrieves the iterator for the object.
 *
 * @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
 *   The iterator.
 */

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

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

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

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

public onChange($property_name, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * @param string $property_name
 *   The name of the property.
 * @param bool $notify
 *   (optional) Whether to forward the notification to the parent. Defaults to
 *   TRUE. By passing FALSE, overrides of this method can re-use the logic
 *   of parent classes without triggering notification.
 */

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

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPluginId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

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

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

protected formatPlural($count, $singular, $plural, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\PluralTranslatableMarkup Formats a string containing a count of items.

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

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

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

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

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

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

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

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

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

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

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

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

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

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

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

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

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

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:27

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:34

public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25

public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32

public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39

public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53

public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223

public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247

public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254

public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261

public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268

public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275

public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282

public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

abstract public static Drupal\Core\Field\FieldItemInterface::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): \Drupal\Core\TypedData\DataDefinitionInterface[] Defines field item properties.

/**
 * Defines field item properties.
 *
 * Properties that are required to constitute a valid, non-empty item should
 * be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
 *
 * @return \Drupal\Core\TypedData\DataDefinitionInterface[]
 *   An array of property definitions of contained properties, keyed by
 *   property name.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35

abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.

/**
 * Returns the schema for the field.
 *
 * This method is static because the field schema information is needed on
 * creation of the field. FieldItemInterface objects instantiated at that
 * time are not reliable as field settings might be missing.
 *
 * Computed fields having no schema should return an empty array.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
 *   The field definition.
 *
 * @return array
 *   An empty array if there is no schema, or an associative array with the
 *   following key/value pairs:
 *   - columns: An array of Schema API column specifications, keyed by column
 *     name. The columns need to be a subset of the properties defined in
 *     propertyDefinitions(). The 'not null' property is ignored if present,
 *     as it is determined automatically by the storage controller depending
 *     on the table layout and the property definitions. It is recommended to
 *     avoid having the column definitions depend on field settings when
 *     possible. No assumptions should be made on how storage engines
 *     internally use the original column name to structure their storage.
 *   - unique keys: (optional) An array of Schema API unique key definitions.
 *     Only columns that appear in the 'columns' array are allowed.
 *   - indexes: (optional) An array of Schema API index definitions. Only
 *     columns that appear in the 'columns' array are allowed. Those indexes
 *     will be used as default indexes. Field definitions can specify
 *     additional indexes or, at their own risk, modify the default indexes
 *     specified by the field-type module. Some storage engines might not
 *     support indexes.
 *   - foreign keys: (optional) An array of Schema API foreign key
 *     definitions. Note, however, that the field data is not necessarily
 *     stored in SQL. Also, the possible usage is limited, as you cannot
 *     specify another field as related, only existing SQL tables,
 *     such as {taxonomy_term_data}.
 *
 * @throws \Drupal\Core\Field\FieldException
 *   Throws an exception if the schema is invalid.
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91

Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted

1 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#9552 (9)

Properties (9)
Methods (49)
Static methods (18)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 (3)

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

protected definition -> array (2)

type => string (27) "field_item:metatag_computed"

settings => array (0)

protected typedDataManager -> null

protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2649 (7)

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

protected definition -> array (10)
label => Drupal\Core\StringTranslation\TranslatableMarkup#2650 Depth Limit
description => Drupal\Core\StringTranslation\TranslatableMarkup#2651 Depth Limit
computed => boolean true
translatable => boolean true
read-only => boolean true
entity_type => string (16) "commerce_product"
cardinality => integer -1
provider => string (7) "metatag"
field_name => string (7) "metatag"
bundle => null
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 Recursion
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2)
tag => Drupal\Core\TypedData\DataDefinition#9287 Depth Limit
attributes => Drupal\Core\TypedData\MapDataDefinition#10017 Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

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

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

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

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

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

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

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

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

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

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

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

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

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

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

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

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

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

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

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

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

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

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

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

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

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

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

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

/**
 * {@inheritdoc}
 */

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

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

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

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

/**
 * Creates a new list definition.
 *
 * @param string $item_type
 *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new List Data Definition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

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

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

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

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

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

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

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

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

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

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

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

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

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

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

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

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

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

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

protected name -> integer 1

protected parent -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8845 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1756 Blacklisted

protected values -> array (2)

tag => string (4) "link"

attributes => array (2)

rel => string (9) "canonical"

href => string (49) "https://tcq.bitanube.com/devel/commerce_product/6"

protected properties -> array (0)

public isEmpty() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:47

public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60

public getEntity() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74

public getLangcode() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88

protected getSettings(): array Returns the array of field settings.

/**
 * Returns the array of field settings.
 *
 * @return array
 *   The array of settings.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98

protected getSetting($setting_name): mixed Returns the value of a field setting.

/**
 * Returns the value of a field setting.
 *
 * @param string $setting_name
 *   The setting name.
 *
 * @return mixed
 *   The setting value.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111

public setValue($values, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118

protected writePropertyValue($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Different to the parent Map class, we avoid creating property objects as
 * far as possible in order to optimize performance. Thus we just update
 * $this->values if no property object has been created yet.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186

public view($display_options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200

public preSave() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208

public postSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218

public deleteRevision() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228

public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233

public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public set($property_name, $value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getProperties($include_computed = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getIterator(): ArrayIterator Retrieves the iterator for the object.

/**
 * Retrieves the iterator for the object.
 *
 * @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
 *   The iterator.
 */

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

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

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

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

public onChange($property_name, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * @param string $property_name
 *   The name of the property.
 * @param bool $notify
 *   (optional) Whether to forward the notification to the parent. Defaults to
 *   TRUE. By passing FALSE, overrides of this method can re-use the logic
 *   of parent classes without triggering notification.
 */

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

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPluginId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

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

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

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

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

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

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

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

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

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

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

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

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

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

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

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

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

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

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

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

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:27

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:34

public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25

public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32

public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39

public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53

public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223

public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247

public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254

public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261

public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268

public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275

public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282

public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * Defines field item properties.
 *
 * Properties that are required to constitute a valid, non-empty item should
 * be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
 *
 * @return \Drupal\Core\TypedData\DataDefinitionInterface[]
 *   An array of property definitions of contained properties, keyed by
 *   property name.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35

abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.

/**
 * Returns the schema for the field.
 *
 * This method is static because the field schema information is needed on
 * creation of the field. FieldItemInterface objects instantiated at that
 * time are not reliable as field settings might be missing.
 *
 * Computed fields having no schema should return an empty array.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
 *   The field definition.
 *
 * @return array
 *   An empty array if there is no schema, or an associative array with the
 *   following key/value pairs:
 *   - columns: An array of Schema API column specifications, keyed by column
 *     name. The columns need to be a subset of the properties defined in
 *     propertyDefinitions(). The 'not null' property is ignored if present,
 *     as it is determined automatically by the storage controller depending
 *     on the table layout and the property definitions. It is recommended to
 *     avoid having the column definitions depend on field settings when
 *     possible. No assumptions should be made on how storage engines
 *     internally use the original column name to structure their storage.
 *   - unique keys: (optional) An array of Schema API unique key definitions.
 *     Only columns that appear in the 'columns' array are allowed.
 *   - indexes: (optional) An array of Schema API index definitions. Only
 *     columns that appear in the 'columns' array are allowed. Those indexes
 *     will be used as default indexes. Field definitions can specify
 *     additional indexes or, at their own risk, modify the default indexes
 *     specified by the field-type module. Some storage engines might not
 *     support indexes.
 *   - foreign keys: (optional) An array of Schema API foreign key
 *     definitions. Note, however, that the field data is not necessarily
 *     stored in SQL. Also, the possible usage is limited, as you cannot
 *     specify another field as related, only existing SQL tables,
 *     such as {taxonomy_term_data}.
 *
 * @throws \Drupal\Core\Field\FieldException
 *   Throws an exception if the schema is invalid.
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91

Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted

2 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#9581 (9)

Properties (9)
Methods (49)
Static methods (18)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 (3)

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

protected definition -> array (2)

type => string (27) "field_item:metatag_computed"

settings => array (0)

protected typedDataManager -> null

protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2649 (7)

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

protected definition -> array (10)
label => Drupal\Core\StringTranslation\TranslatableMarkup#2650 Depth Limit
description => Drupal\Core\StringTranslation\TranslatableMarkup#2651 Depth Limit
computed => boolean true
translatable => boolean true
read-only => boolean true
entity_type => string (16) "commerce_product"
cardinality => integer -1
provider => string (7) "metatag"
field_name => string (7) "metatag"
bundle => null
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 Recursion
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2)
tag => Drupal\Core\TypedData\DataDefinition#9287 Depth Limit
attributes => Drupal\Core\TypedData\MapDataDefinition#10017 Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

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

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

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

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

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

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

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

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

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

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

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

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

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

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

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

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

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

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

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

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

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

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

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

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

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

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

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

/**
 * {@inheritdoc}
 */

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

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

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

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

/**
 * Creates a new list definition.
 *
 * @param string $item_type
 *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new List Data Definition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

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

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

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

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

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

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

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

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

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

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

/**
 * {@inheritdoc}
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

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

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

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

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

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

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

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

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

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

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

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

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

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

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

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

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

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

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

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

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

/**
 * {@inheritdoc}
 */

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

protected name -> integer 2

protected parent -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8845 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1756 Blacklisted

protected values -> array (2)

tag => string (4) "meta"

attributes => array (4)

name => string (19) "isAccessibleForFree"

content => string (4) "True"

group => string (14) "schema_article"

schema_metatag => boolean true

protected properties -> array (0)

public isEmpty() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:47

public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60

public getEntity() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74

public getLangcode() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88

protected getSettings(): array Returns the array of field settings.

/**
 * Returns the array of field settings.
 *
 * @return array
 *   The array of settings.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98

protected getSetting($setting_name): mixed Returns the value of a field setting.

/**
 * Returns the value of a field setting.
 *
 * @param string $setting_name
 *   The setting name.
 *
 * @return mixed
 *   The setting value.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111

public setValue($values, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118

protected writePropertyValue($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Different to the parent Map class, we avoid creating property objects as
 * far as possible in order to optimize performance. Thus we just update
 * $this->values if no property object has been created yet.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186

public view($display_options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200

public preSave() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208

public postSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218

public deleteRevision() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228

public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233

public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public set($property_name, $value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getProperties($include_computed = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getIterator(): ArrayIterator Retrieves the iterator for the object.

/**
 * Retrieves the iterator for the object.
 *
 * @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
 *   The iterator.
 */

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

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

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

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

public onChange($property_name, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * @param string $property_name
 *   The name of the property.
 * @param bool $notify
 *   (optional) Whether to forward the notification to the parent. Defaults to
 *   TRUE. By passing FALSE, overrides of this method can re-use the logic
 *   of parent classes without triggering notification.
 */

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

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPluginId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

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

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

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:27

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:34

public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25

public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32

public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39

public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46

public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53

public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223

public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247

public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254

public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261

public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268

public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275

public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282

public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46

/**
 * Defines field item properties.
 *
 * Properties that are required to constitute a valid, non-empty item should
 * be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
 *
 * @return \Drupal\Core\TypedData\DataDefinitionInterface[]
 *   An array of property definitions of contained properties, keyed by
 *   property name.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35

abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.

/**
 * Returns the schema for the field.
 *
 * This method is static because the field schema information is needed on
 * creation of the field. FieldItemInterface objects instantiated at that
 * time are not reliable as field settings might be missing.
 *
 * Computed fields having no schema should return an empty array.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
 *   The field definition.
 *
 * @return array
 *   An empty array if there is no schema, or an associative array with the
 *   following key/value pairs:
 *   - columns: An array of Schema API column specifications, keyed by column
 *     name. The columns need to be a subset of the properties defined in
 *     propertyDefinitions(). The 'not null' property is ignored if present,
 *     as it is determined automatically by the storage controller depending
 *     on the table layout and the property definitions. It is recommended to
 *     avoid having the column definitions depend on field settings when
 *     possible. No assumptions should be made on how storage engines
 *     internally use the original column name to structure their storage.
 *   - unique keys: (optional) An array of Schema API unique key definitions.
 *     Only columns that appear in the 'columns' array are allowed.
 *   - indexes: (optional) An array of Schema API index definitions. Only
 *     columns that appear in the 'columns' array are allowed. Those indexes
 *     will be used as default indexes. Field definitions can specify
 *     additional indexes or, at their own risk, modify the default indexes
 *     specified by the field-type module. Some storage engines might not
 *     support indexes.
 *   - foreign keys: (optional) An array of Schema API foreign key
 *     definitions. Note, however, that the field data is not necessarily
 *     stored in SQL. Also, the possible usage is limited, as you cannot
 *     specify another field as related, only existing SQL tables,
 *     such as {taxonomy_term_data}.
 *
 * @throws \Drupal\Core\Field\FieldException
 *   Throws an exception if the schema is invalid.
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91

Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted

3 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#9574 (9)

Properties (9)
Methods (49)
Static methods (18)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)

type => string (27) "field_item:metatag_computed"

settings => array (0)

protected typedDataManager -> null

protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2649 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10)
label => Drupal\Core\StringTranslation\TranslatableMarkup#2650 Depth Limit
description => Drupal\Core\StringTranslation\TranslatableMarkup#2651 Depth Limit
computed => boolean true
translatable => boolean true
read-only => boolean true
entity_type => string (16) "commerce_product"
cardinality => integer -1
provider => string (7) "metatag"
field_name => string (7) "metatag"
bundle => null
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 Recursion
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2)
tag => Drupal\Core\TypedData\DataDefinition#9287 Depth Limit
attributes => Drupal\Core\TypedData\MapDataDefinition#10017 Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * Creates a new field definition based upon a field storage definition.
 *
 * In cases where one needs a field storage definitions to act like full
 * field definitions, this creates a new field definition based upon the
 * (limited) information available. That way it is possible to use the field
 * definition in places where a full field definition is required; e.g., with
 * widgets or formatters.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
 *   The field storage definition to base the new field definition upon.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33

protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.

/**
 * Creates a new list definition.
 *
 * @param string $item_type
 *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new List Data Definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26

public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected name -> integer 3

protected parent -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8845 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1756 Blacklisted

protected values -> array (2)

tag => string (4) "meta"

attributes => array (4)

name => string (5) "@type"

content => string (12) "Organization"

group => string (19) "schema_organization"

schema_metatag => boolean true

protected properties -> array (0)

public isEmpty() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:47

public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60

public getEntity() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74

public getLangcode() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88

protected getSettings(): array Returns the array of field settings.

/**
 * Returns the array of field settings.
 *
 * @return array
 *   The array of settings.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98

protected getSetting($setting_name): mixed Returns the value of a field setting.

/**
 * Returns the value of a field setting.
 *
 * @param string $setting_name
 *   The setting name.
 *
 * @return mixed
 *   The setting value.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111

public setValue($values, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118

protected writePropertyValue($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Different to the parent Map class, we avoid creating property objects as
 * far as possible in order to optimize performance. Thus we just update
 * $this->values if no property object has been created yet.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186

public view($display_options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200

public preSave() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208

public postSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218

public deleteRevision() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228

public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233

public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:58

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:106

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:118

public set($property_name, $value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:133

public getProperties($include_computed = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:165

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:178

public getIterator(): ArrayIterator Retrieves the iterator for the object.

/**
 * Retrieves the iterator for the object.
 *
 * @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
 *   The iterator.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:192

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:219

public onChange($property_name, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * @param string $property_name
 *   The name of the property.
 * @param bool $notify
 *   (optional) Whether to forward the notification to the parent. Defaults to
 *   TRUE. By passing FALSE, overrides of this method can re-use the logic
 *   of parent classes without triggering notification.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:236

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:246

public getPluginId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:27

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:34

public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25

public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32

public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39

public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46

public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53

public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223

public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247

public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254

public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261

public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268

public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275

public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282

public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46

/**
 * Defines field item properties.
 *
 * Properties that are required to constitute a valid, non-empty item should
 * be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
 *
 * @return \Drupal\Core\TypedData\DataDefinitionInterface[]
 *   An array of property definitions of contained properties, keyed by
 *   property name.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35

abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.

/**
 * Returns the schema for the field.
 *
 * This method is static because the field schema information is needed on
 * creation of the field. FieldItemInterface objects instantiated at that
 * time are not reliable as field settings might be missing.
 *
 * Computed fields having no schema should return an empty array.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
 *   The field definition.
 *
 * @return array
 *   An empty array if there is no schema, or an associative array with the
 *   following key/value pairs:
 *   - columns: An array of Schema API column specifications, keyed by column
 *     name. The columns need to be a subset of the properties defined in
 *     propertyDefinitions(). The 'not null' property is ignored if present,
 *     as it is determined automatically by the storage controller depending
 *     on the table layout and the property definitions. It is recommended to
 *     avoid having the column definitions depend on field settings when
 *     possible. No assumptions should be made on how storage engines
 *     internally use the original column name to structure their storage.
 *   - unique keys: (optional) An array of Schema API unique key definitions.
 *     Only columns that appear in the 'columns' array are allowed.
 *   - indexes: (optional) An array of Schema API index definitions. Only
 *     columns that appear in the 'columns' array are allowed. Those indexes
 *     will be used as default indexes. Field definitions can specify
 *     additional indexes or, at their own risk, modify the default indexes
 *     specified by the field-type module. Some storage engines might not
 *     support indexes.
 *   - foreign keys: (optional) An array of Schema API foreign key
 *     definitions. Note, however, that the field data is not necessarily
 *     stored in SQL. Also, the possible usage is limited, as you cannot
 *     specify another field as related, only existing SQL tables,
 *     such as {taxonomy_term_data}.
 *
 * @throws \Drupal\Core\Field\FieldException
 *   Throws an exception if the schema is invalid.
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91

Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted

4 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#10127 (9)

Properties (9)
Methods (49)
Static methods (18)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)

type => string (27) "field_item:metatag_computed"

settings => array (0)

protected typedDataManager -> null

protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2649 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10)
label => Drupal\Core\StringTranslation\TranslatableMarkup#2650 Depth Limit
description => Drupal\Core\StringTranslation\TranslatableMarkup#2651 Depth Limit
computed => boolean true
translatable => boolean true
read-only => boolean true
entity_type => string (16) "commerce_product"
cardinality => integer -1
provider => string (7) "metatag"
field_name => string (7) "metatag"
bundle => null
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 Recursion
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2)
tag => Drupal\Core\TypedData\DataDefinition#9287 Depth Limit
attributes => Drupal\Core\TypedData\MapDataDefinition#10017 Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * Creates a new field definition based upon a field storage definition.
 *
 * In cases where one needs a field storage definitions to act like full
 * field definitions, this creates a new field definition based upon the
 * (limited) information available. That way it is possible to use the field
 * definition in places where a full field definition is required; e.g., with
 * widgets or formatters.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
 *   The field storage definition to base the new field definition upon.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33

protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.

/**
 * Creates a new list definition.
 *
 * @param string $item_type
 *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new List Data Definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26

public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected name -> integer 4

protected parent -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8845 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1756 Blacklisted

protected values -> array (2)

tag => string (4) "meta"

attributes => array (4)

name => string (3) "@id"

content => string (25) "https://tcq.bitanube.com/"

group => string (19) "schema_organization"

schema_metatag => boolean true

protected properties -> array (0)

public isEmpty() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:47

public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60

public getEntity() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74

public getLangcode() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88

protected getSettings(): array Returns the array of field settings.

/**
 * Returns the array of field settings.
 *
 * @return array
 *   The array of settings.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98

protected getSetting($setting_name): mixed Returns the value of a field setting.

/**
 * Returns the value of a field setting.
 *
 * @param string $setting_name
 *   The setting name.
 *
 * @return mixed
 *   The setting value.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111

public setValue($values, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118

protected writePropertyValue($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Different to the parent Map class, we avoid creating property objects as
 * far as possible in order to optimize performance. Thus we just update
 * $this->values if no property object has been created yet.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186

public view($display_options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200

public preSave() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208

public postSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218

public deleteRevision() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228

public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233

public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:58

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:106

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:118

public set($property_name, $value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:133

public getProperties($include_computed = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:165

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:178

public getIterator(): ArrayIterator Retrieves the iterator for the object.

/**
 * Retrieves the iterator for the object.
 *
 * @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
 *   The iterator.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:192

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:219

public onChange($property_name, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * @param string $property_name
 *   The name of the property.
 * @param bool $notify
 *   (optional) Whether to forward the notification to the parent. Defaults to
 *   TRUE. By passing FALSE, overrides of this method can re-use the logic
 *   of parent classes without triggering notification.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:236

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:246

public getPluginId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:27

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:34

public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25

public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32

public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39

public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46

public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53

public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223

public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247

public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254

public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261

public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268

public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275

public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282

public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46

/**
 * Defines field item properties.
 *
 * Properties that are required to constitute a valid, non-empty item should
 * be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
 *
 * @return \Drupal\Core\TypedData\DataDefinitionInterface[]
 *   An array of property definitions of contained properties, keyed by
 *   property name.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35

abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.

/**
 * Returns the schema for the field.
 *
 * This method is static because the field schema information is needed on
 * creation of the field. FieldItemInterface objects instantiated at that
 * time are not reliable as field settings might be missing.
 *
 * Computed fields having no schema should return an empty array.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
 *   The field definition.
 *
 * @return array
 *   An empty array if there is no schema, or an associative array with the
 *   following key/value pairs:
 *   - columns: An array of Schema API column specifications, keyed by column
 *     name. The columns need to be a subset of the properties defined in
 *     propertyDefinitions(). The 'not null' property is ignored if present,
 *     as it is determined automatically by the storage controller depending
 *     on the table layout and the property definitions. It is recommended to
 *     avoid having the column definitions depend on field settings when
 *     possible. No assumptions should be made on how storage engines
 *     internally use the original column name to structure their storage.
 *   - unique keys: (optional) An array of Schema API unique key definitions.
 *     Only columns that appear in the 'columns' array are allowed.
 *   - indexes: (optional) An array of Schema API index definitions. Only
 *     columns that appear in the 'columns' array are allowed. Those indexes
 *     will be used as default indexes. Field definitions can specify
 *     additional indexes or, at their own risk, modify the default indexes
 *     specified by the field-type module. Some storage engines might not
 *     support indexes.
 *   - foreign keys: (optional) An array of Schema API foreign key
 *     definitions. Note, however, that the field data is not necessarily
 *     stored in SQL. Also, the possible usage is limited, as you cannot
 *     specify another field as related, only existing SQL tables,
 *     such as {taxonomy_term_data}.
 *
 * @throws \Drupal\Core\Field\FieldException
 *   Throws an exception if the schema is invalid.
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91

Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted

5 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#10008 (9)

Properties (9)
Methods (49)
Static methods (18)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)

type => string (27) "field_item:metatag_computed"

settings => array (0)

protected typedDataManager -> null

protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2649 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10)
label => Drupal\Core\StringTranslation\TranslatableMarkup#2650 Depth Limit
description => Drupal\Core\StringTranslation\TranslatableMarkup#2651 Depth Limit
computed => boolean true
translatable => boolean true
read-only => boolean true
entity_type => string (16) "commerce_product"
cardinality => integer -1
provider => string (7) "metatag"
field_name => string (7) "metatag"
bundle => null
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 Recursion
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2)
tag => Drupal\Core\TypedData\DataDefinition#9287 Depth Limit
attributes => Drupal\Core\TypedData\MapDataDefinition#10017 Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * Creates a new field definition based upon a field storage definition.
 *
 * In cases where one needs a field storage definitions to act like full
 * field definitions, this creates a new field definition based upon the
 * (limited) information available. That way it is possible to use the field
 * definition in places where a full field definition is required; e.g., with
 * widgets or formatters.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
 *   The field storage definition to base the new field definition upon.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33

protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.

/**
 * Creates a new list definition.
 *
 * @param string $item_type
 *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new List Data Definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26

public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected name -> integer 5

protected parent -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8845 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1756 Blacklisted

protected values -> array (2)

tag => string (4) "meta"

attributes => array (4)

name => string (11) "description"

content => UTF-8 string (186) "Somos tu aliado estratégico para el crecimiento y la eficiencia de tu empres...

Somos tu aliado estratégico para el crecimiento y la eficiencia de tu empresa. Ofrecemos una amplia gama de servicios personalizados para satisfacer todas tus necesidades empresariales.

group => string (19) "schema_organization"

schema_metatag => boolean true

protected properties -> array (0)

public isEmpty() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:47

public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60

public getEntity() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74

public getLangcode() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88

protected getSettings(): array Returns the array of field settings.

/**
 * Returns the array of field settings.
 *
 * @return array
 *   The array of settings.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98

protected getSetting($setting_name): mixed Returns the value of a field setting.

/**
 * Returns the value of a field setting.
 *
 * @param string $setting_name
 *   The setting name.
 *
 * @return mixed
 *   The setting value.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111

public setValue($values, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118

protected writePropertyValue($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Different to the parent Map class, we avoid creating property objects as
 * far as possible in order to optimize performance. Thus we just update
 * $this->values if no property object has been created yet.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186

public view($display_options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200

public preSave() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208

public postSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218

public deleteRevision() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228

public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233

public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:58

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:106

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:118

public set($property_name, $value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:133

public getProperties($include_computed = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:165

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:178

public getIterator(): ArrayIterator Retrieves the iterator for the object.

/**
 * Retrieves the iterator for the object.
 *
 * @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
 *   The iterator.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:192

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:219

public onChange($property_name, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * @param string $property_name
 *   The name of the property.
 * @param bool $notify
 *   (optional) Whether to forward the notification to the parent. Defaults to
 *   TRUE. By passing FALSE, overrides of this method can re-use the logic
 *   of parent classes without triggering notification.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:236

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:246

public getPluginId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:27

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:34

public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25

public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32

public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39

public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46

public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53

public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223

public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247

public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254

public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261

public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268

public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275

public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282

public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46

/**
 * Defines field item properties.
 *
 * Properties that are required to constitute a valid, non-empty item should
 * be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
 *
 * @return \Drupal\Core\TypedData\DataDefinitionInterface[]
 *   An array of property definitions of contained properties, keyed by
 *   property name.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35

abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.

/**
 * Returns the schema for the field.
 *
 * This method is static because the field schema information is needed on
 * creation of the field. FieldItemInterface objects instantiated at that
 * time are not reliable as field settings might be missing.
 *
 * Computed fields having no schema should return an empty array.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
 *   The field definition.
 *
 * @return array
 *   An empty array if there is no schema, or an associative array with the
 *   following key/value pairs:
 *   - columns: An array of Schema API column specifications, keyed by column
 *     name. The columns need to be a subset of the properties defined in
 *     propertyDefinitions(). The 'not null' property is ignored if present,
 *     as it is determined automatically by the storage controller depending
 *     on the table layout and the property definitions. It is recommended to
 *     avoid having the column definitions depend on field settings when
 *     possible. No assumptions should be made on how storage engines
 *     internally use the original column name to structure their storage.
 *   - unique keys: (optional) An array of Schema API unique key definitions.
 *     Only columns that appear in the 'columns' array are allowed.
 *   - indexes: (optional) An array of Schema API index definitions. Only
 *     columns that appear in the 'columns' array are allowed. Those indexes
 *     will be used as default indexes. Field definitions can specify
 *     additional indexes or, at their own risk, modify the default indexes
 *     specified by the field-type module. Some storage engines might not
 *     support indexes.
 *   - foreign keys: (optional) An array of Schema API foreign key
 *     definitions. Note, however, that the field data is not necessarily
 *     stored in SQL. Also, the possible usage is limited, as you cannot
 *     specify another field as related, only existing SQL tables,
 *     such as {taxonomy_term_data}.
 *
 * @throws \Drupal\Core\Field\FieldException
 *   Throws an exception if the schema is invalid.
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91

Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted

6 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#10129 (9)

Properties (9)
Methods (49)
Static methods (18)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)

type => string (27) "field_item:metatag_computed"

settings => array (0)

protected typedDataManager -> null

protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2649 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10)
label => Drupal\Core\StringTranslation\TranslatableMarkup#2650 Depth Limit
description => Drupal\Core\StringTranslation\TranslatableMarkup#2651 Depth Limit
computed => boolean true
translatable => boolean true
read-only => boolean true
entity_type => string (16) "commerce_product"
cardinality => integer -1
provider => string (7) "metatag"
field_name => string (7) "metatag"
bundle => null
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 Recursion
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2)
tag => Drupal\Core\TypedData\DataDefinition#9287 Depth Limit
attributes => Drupal\Core\TypedData\MapDataDefinition#10017 Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * Creates a new field definition based upon a field storage definition.
 *
 * In cases where one needs a field storage definitions to act like full
 * field definitions, this creates a new field definition based upon the
 * (limited) information available. That way it is possible to use the field
 * definition in places where a full field definition is required; e.g., with
 * widgets or formatters.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
 *   The field storage definition to base the new field definition upon.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33

protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.

/**
 * Creates a new list definition.
 *
 * @param string $item_type
 *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new List Data Definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26

public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected name -> integer 6

protected parent -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8845 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1756 Blacklisted

protected values -> array (2)

tag => string (4) "meta"

attributes => array (4)

name => string (4) "name"

content => UTF-8 string (19) "Zausen Consultoría"

group => string (19) "schema_organization"

schema_metatag => boolean true

protected properties -> array (0)

public isEmpty() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:47

public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60

public getEntity() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74

public getLangcode() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88

protected getSettings(): array Returns the array of field settings.

/**
 * Returns the array of field settings.
 *
 * @return array
 *   The array of settings.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98

protected getSetting($setting_name): mixed Returns the value of a field setting.

/**
 * Returns the value of a field setting.
 *
 * @param string $setting_name
 *   The setting name.
 *
 * @return mixed
 *   The setting value.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111

public setValue($values, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118

protected writePropertyValue($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Different to the parent Map class, we avoid creating property objects as
 * far as possible in order to optimize performance. Thus we just update
 * $this->values if no property object has been created yet.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186

public view($display_options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200

public preSave() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208

public postSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218

public deleteRevision() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228

public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233

public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:58

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:106

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:118

public set($property_name, $value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:133

public getProperties($include_computed = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:165

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:178

public getIterator(): ArrayIterator Retrieves the iterator for the object.

/**
 * Retrieves the iterator for the object.
 *
 * @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
 *   The iterator.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:192

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:219

public onChange($property_name, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * @param string $property_name
 *   The name of the property.
 * @param bool $notify
 *   (optional) Whether to forward the notification to the parent. Defaults to
 *   TRUE. By passing FALSE, overrides of this method can re-use the logic
 *   of parent classes without triggering notification.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:236

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:246

public getPluginId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:27

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:34

public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25

public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32

public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39

public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46

public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53

public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223

public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247

public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254

public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261

public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268

public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275

public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282

public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46

/**
 * Defines field item properties.
 *
 * Properties that are required to constitute a valid, non-empty item should
 * be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
 *
 * @return \Drupal\Core\TypedData\DataDefinitionInterface[]
 *   An array of property definitions of contained properties, keyed by
 *   property name.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35

abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.

/**
 * Returns the schema for the field.
 *
 * This method is static because the field schema information is needed on
 * creation of the field. FieldItemInterface objects instantiated at that
 * time are not reliable as field settings might be missing.
 *
 * Computed fields having no schema should return an empty array.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
 *   The field definition.
 *
 * @return array
 *   An empty array if there is no schema, or an associative array with the
 *   following key/value pairs:
 *   - columns: An array of Schema API column specifications, keyed by column
 *     name. The columns need to be a subset of the properties defined in
 *     propertyDefinitions(). The 'not null' property is ignored if present,
 *     as it is determined automatically by the storage controller depending
 *     on the table layout and the property definitions. It is recommended to
 *     avoid having the column definitions depend on field settings when
 *     possible. No assumptions should be made on how storage engines
 *     internally use the original column name to structure their storage.
 *   - unique keys: (optional) An array of Schema API unique key definitions.
 *     Only columns that appear in the 'columns' array are allowed.
 *   - indexes: (optional) An array of Schema API index definitions. Only
 *     columns that appear in the 'columns' array are allowed. Those indexes
 *     will be used as default indexes. Field definitions can specify
 *     additional indexes or, at their own risk, modify the default indexes
 *     specified by the field-type module. Some storage engines might not
 *     support indexes.
 *   - foreign keys: (optional) An array of Schema API foreign key
 *     definitions. Note, however, that the field data is not necessarily
 *     stored in SQL. Also, the possible usage is limited, as you cannot
 *     specify another field as related, only existing SQL tables,
 *     such as {taxonomy_term_data}.
 *
 * @throws \Drupal\Core\Field\FieldException
 *   Throws an exception if the schema is invalid.
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91

Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted

7 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#10130 (9)

Properties (9)
Methods (49)
Static methods (18)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)

type => string (27) "field_item:metatag_computed"

settings => array (0)

protected typedDataManager -> null

protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2649 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10)
label => Drupal\Core\StringTranslation\TranslatableMarkup#2650 Depth Limit
description => Drupal\Core\StringTranslation\TranslatableMarkup#2651 Depth Limit
computed => boolean true
translatable => boolean true
read-only => boolean true
entity_type => string (16) "commerce_product"
cardinality => integer -1
provider => string (7) "metatag"
field_name => string (7) "metatag"
bundle => null
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 Recursion
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2)
tag => Drupal\Core\TypedData\DataDefinition#9287 Depth Limit
attributes => Drupal\Core\TypedData\MapDataDefinition#10017 Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * Creates a new field definition based upon a field storage definition.
 *
 * In cases where one needs a field storage definitions to act like full
 * field definitions, this creates a new field definition based upon the
 * (limited) information available. That way it is possible to use the field
 * definition in places where a full field definition is required; e.g., with
 * widgets or formatters.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
 *   The field storage definition to base the new field definition upon.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33

protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.

/**
 * Creates a new list definition.
 *
 * @param string $item_type
 *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new List Data Definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26

public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected name -> integer 7

protected parent -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8845 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1756 Blacklisted

protected values -> array (2)

tag => string (4) "meta"

attributes => array (4)

name => string (3) "url"

content => string (25) "https://tcq.bitanube.com/"

group => string (19) "schema_organization"

schema_metatag => boolean true

protected properties -> array (0)

public isEmpty() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:47

public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60

public getEntity() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74

public getLangcode() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88

protected getSettings(): array Returns the array of field settings.

/**
 * Returns the array of field settings.
 *
 * @return array
 *   The array of settings.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98

protected getSetting($setting_name): mixed Returns the value of a field setting.

/**
 * Returns the value of a field setting.
 *
 * @param string $setting_name
 *   The setting name.
 *
 * @return mixed
 *   The setting value.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111

public setValue($values, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118

protected writePropertyValue($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Different to the parent Map class, we avoid creating property objects as
 * far as possible in order to optimize performance. Thus we just update
 * $this->values if no property object has been created yet.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186

public view($display_options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200

public preSave() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208

public postSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218

public deleteRevision() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228

public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233

public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:58

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:106

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:118

public set($property_name, $value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:133

public getProperties($include_computed = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:165

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:178

public getIterator(): ArrayIterator Retrieves the iterator for the object.

/**
 * Retrieves the iterator for the object.
 *
 * @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
 *   The iterator.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:192

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:219

public onChange($property_name, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * @param string $property_name
 *   The name of the property.
 * @param bool $notify
 *   (optional) Whether to forward the notification to the parent. Defaults to
 *   TRUE. By passing FALSE, overrides of this method can re-use the logic
 *   of parent classes without triggering notification.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:236

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:246

public getPluginId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:27

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:34

public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25

public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32

public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39

public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46

public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53

public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223

public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247

public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254

public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261

public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268

public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275

public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282

public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46

/**
 * Defines field item properties.
 *
 * Properties that are required to constitute a valid, non-empty item should
 * be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
 *
 * @return \Drupal\Core\TypedData\DataDefinitionInterface[]
 *   An array of property definitions of contained properties, keyed by
 *   property name.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35

abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.

/**
 * Returns the schema for the field.
 *
 * This method is static because the field schema information is needed on
 * creation of the field. FieldItemInterface objects instantiated at that
 * time are not reliable as field settings might be missing.
 *
 * Computed fields having no schema should return an empty array.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
 *   The field definition.
 *
 * @return array
 *   An empty array if there is no schema, or an associative array with the
 *   following key/value pairs:
 *   - columns: An array of Schema API column specifications, keyed by column
 *     name. The columns need to be a subset of the properties defined in
 *     propertyDefinitions(). The 'not null' property is ignored if present,
 *     as it is determined automatically by the storage controller depending
 *     on the table layout and the property definitions. It is recommended to
 *     avoid having the column definitions depend on field settings when
 *     possible. No assumptions should be made on how storage engines
 *     internally use the original column name to structure their storage.
 *   - unique keys: (optional) An array of Schema API unique key definitions.
 *     Only columns that appear in the 'columns' array are allowed.
 *   - indexes: (optional) An array of Schema API index definitions. Only
 *     columns that appear in the 'columns' array are allowed. Those indexes
 *     will be used as default indexes. Field definitions can specify
 *     additional indexes or, at their own risk, modify the default indexes
 *     specified by the field-type module. Some storage engines might not
 *     support indexes.
 *   - foreign keys: (optional) An array of Schema API foreign key
 *     definitions. Note, however, that the field data is not necessarily
 *     stored in SQL. Also, the possible usage is limited, as you cannot
 *     specify another field as related, only existing SQL tables,
 *     such as {taxonomy_term_data}.
 *
 * @throws \Drupal\Core\Field\FieldException
 *   Throws an exception if the schema is invalid.
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91

Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted

8 => Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem#10131 (9)

Properties (9)
Methods (49)
Static methods (18)
Iterator

protected definition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)

type => string (27) "field_item:metatag_computed"

settings => array (0)

protected typedDataManager -> null

protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2649 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10)
label => Drupal\Core\StringTranslation\TranslatableMarkup#2650 Depth Limit
description => Drupal\Core\StringTranslation\TranslatableMarkup#2651 Depth Limit
computed => boolean true
translatable => boolean true
read-only => boolean true
entity_type => string (16) "commerce_product"
cardinality => integer -1
provider => string (7) "metatag"
field_name => string (7) "metatag"
bundle => null
protected typedDataManager -> null
protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 Recursion
protected type -> string (16) "metatag_computed"
protected propertyDefinitions -> array (2)
tag => Drupal\Core\TypedData\DataDefinition#9287 Depth Limit
attributes => Drupal\Core\TypedData\MapDataDefinition#10017 Depth Limit
protected schema -> null
protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * Creates a new field definition based upon a field storage definition.
 *
 * In cases where one needs a field storage definitions to act like full
 * field definitions, this creates a new field definition based upon the
 * (limited) information available. That way it is possible to use the field
 * definition in places where a full field definition is required; e.g., with
 * widgets or formatters.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
 *   The field storage definition to base the new field definition upon.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33

protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.

/**
 * Creates a new list definition.
 *
 * @param string $item_type
 *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new List Data Definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26

public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected name -> integer 8

protected parent -> Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList#8845 Recursion

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1756 Blacklisted

protected values -> array (2)

tag => string (4) "meta"

attributes => array (4)

name => string (4) "logo"

content => array (5)

@type => string (11) "ImageObject"

representativeOfPage => string (5) "False"

url => string (35) "/sites/default/files/taxi-logo.avif"

width => string (2) "60"

height => string (2) "60"

group => string (19) "schema_organization"

schema_metatag => boolean true

protected properties -> array (0)

public isEmpty() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:47

public __construct(Drupal\Core\TypedData\ComplexDataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:60

public getEntity() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:74

public getLangcode() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:81

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:88

protected getSettings(): array Returns the array of field settings.

/**
 * Returns the array of field settings.
 *
 * @return array
 *   The array of settings.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:98

protected getSetting($setting_name): mixed Returns the value of a field setting.

/**
 * Returns the value of a field setting.
 *
 * @param string $setting_name
 *   The setting name.
 *
 * @return mixed
 *   The setting value.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:111

public setValue($values, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:118

protected writePropertyValue($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Different to the parent Map class, we avoid creating property objects as
 * far as possible in order to optimize performance. Thus we just update
 * $this->values if no property object has been created yet.
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:135

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:150

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:164

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:176

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:186

public view($display_options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:200

public preSave() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:208

public postSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:213

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:218

public deleteRevision() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:228

public storageSettingsForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state, $has_data) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:233

public fieldSettingsForm(array $form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:240

public getValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:58

public getString() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:106

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:118

public set($property_name, $value, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:133

public getProperties($include_computed = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:165

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:178

public getIterator(): ArrayIterator Retrieves the iterator for the object.

/**
 * Retrieves the iterator for the object.
 *
 * @return \ArrayIterator<string, \Drupal\Core\TypedData\TypedDataInterface>
 *   The iterator.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:192

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:219

public onChange($property_name, $notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * @param string $property_name
 *   The name of the property.
 * @param bool $notify
 *   (optional) Whether to forward the notification to the parent. Defaults to
 *   TRUE. By passing FALSE, overrides of this method can re-use the logic
 *   of parent classes without triggering notification.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:236

public applyDefaultValue($notify = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\Map
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/Map.php:246

public getPluginId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:119

public validate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use.

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:27

public static Drupal\metatag\Plugin\Field\FieldType\ComputedMetatagsFieldItem::propertyDefinitions(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/FieldType/ComputedMetatagsFieldItem.php:34

public static Drupal\Core\Field\FieldItemBase::defaultStorageSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:25

public static Drupal\Core\Field\FieldItemBase::defaultFieldSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:32

public static Drupal\Core\Field\FieldItemBase::storageSettingsSummary(Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:39

public static Drupal\Core\Field\FieldItemBase::fieldSettingsSummary(Drupal\Core\Field\FieldDefinitionInterface $field_definition): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:46

public static Drupal\Core\Field\FieldItemBase::mainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:53

public static Drupal\Core\Field\FieldItemBase::generateSampleValue(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:223

public static Drupal\Core\Field\FieldItemBase::storageSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:247

public static Drupal\Core\Field\FieldItemBase::storageSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:254

public static Drupal\Core\Field\FieldItemBase::fieldSettingsToConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:261

public static Drupal\Core\Field\FieldItemBase::fieldSettingsFromConfigData(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:268

public static Drupal\Core\Field\FieldItemBase::calculateDependencies(Drupal\Core\Field\FieldDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:275

public static Drupal\Core\Field\FieldItemBase::calculateStorageDependencies(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:282

public static Drupal\Core\Field\FieldItemBase::onDependencyRemoval(Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemBase.php:289

public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46

/**
 * Defines field item properties.
 *
 * Properties that are required to constitute a valid, non-empty item should
 * be denoted with \Drupal\Core\TypedData\DataDefinition::setRequired().
 *
 * @return \Drupal\Core\TypedData\DataDefinitionInterface[]
 *   An array of property definitions of contained properties, keyed by
 *   property name.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:35

abstract public static Drupal\Core\Field\FieldItemInterface::schema(Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition): array Returns the schema for the field.

/**
 * Returns the schema for the field.
 *
 * This method is static because the field schema information is needed on
 * creation of the field. FieldItemInterface objects instantiated at that
 * time are not reliable as field settings might be missing.
 *
 * Computed fields having no schema should return an empty array.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $field_definition
 *   The field definition.
 *
 * @return array
 *   An empty array if there is no schema, or an associative array with the
 *   following key/value pairs:
 *   - columns: An array of Schema API column specifications, keyed by column
 *     name. The columns need to be a subset of the properties defined in
 *     propertyDefinitions(). The 'not null' property is ignored if present,
 *     as it is determined automatically by the storage controller depending
 *     on the table layout and the property definitions. It is recommended to
 *     avoid having the column definitions depend on field settings when
 *     possible. No assumptions should be made on how storage engines
 *     internally use the original column name to structure their storage.
 *   - unique keys: (optional) An array of Schema API unique key definitions.
 *     Only columns that appear in the 'columns' array are allowed.
 *   - indexes: (optional) An array of Schema API index definitions. Only
 *     columns that appear in the 'columns' array are allowed. Those indexes
 *     will be used as default indexes. Field definitions can specify
 *     additional indexes or, at their own risk, modify the default indexes
 *     specified by the field-type module. Some storage engines might not
 *     support indexes.
 *   - foreign keys: (optional) An array of Schema API foreign key
 *     definitions. Note, however, that the field data is not necessarily
 *     stored in SQL. Also, the possible usage is limited, as you cannot
 *     specify another field as related, only existing SQL tables,
 *     such as {taxonomy_term_data}.
 *
 * @throws \Drupal\Core\Field\FieldException
 *   Throws an exception if the schema is invalid.
 */

Inherited from Drupal\Core\Field\FieldItemInterface
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemInterface.php:91

Drupal\Core\Field\FieldItemInterface Iterator Contents uninitialized Blacklisted

protected langcode -> string (2) "es"

protected metatagsGenerated -> boolean true

protected valueComputed -> boolean true

protected valueNeedsRecomputing() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/MetatagEntityFieldItemList.php:30

protected computeValue() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/metatag/src/Plugin/Field/MetatagEntityFieldItemList.php:37

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0->metatag->getEntity()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0->metatag->setLangcode()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0->metatag->getLangcode()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0->metatag->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0->metatag->getSettings()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0->metatag->getSetting()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0->metatag->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0->metatag->setValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:50

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0->metatag->access()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0->metatag->defaultAccess()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0->metatag->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:145

public preSave() {@inheritdoc} $0->metatag->preSave()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0->metatag->postSave()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0->metatag->delete()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0->metatag->deleteRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0->metatag->view()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0->metatag->generateSampleItems()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0->metatag->getConstraints()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0->metatag->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0->metatag->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:308

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0->metatag->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0->metatag->equals()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0->metatag->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0->metatag->getValue()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:42

public getString() {@inheritdoc} $0->metatag->getString()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:61

public get($index) {@inheritdoc} $0->metatag->get()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:69

public set($index, $value) {@inheritdoc} $0->metatag->set()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:89

public removeItem($index) {@inheritdoc} $0->metatag->removeItem()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:105

protected rekey($from_index = 0) Renumbers the items in the list.

/**
 * Renumbers the items in the list.
 *
 * @param int $from_index
 *   Optionally, the index at which to start the renumbering, if it is known
 *   that items before that can safely be skipped (for example, when removing
 *   an item at a given index).
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:158

public first() {@inheritdoc} $0->metatag->first()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:171

public offsetExists($offset): bool {@inheritdoc} $0->metatag->offsetExists()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:121

public offsetUnset($offset): void {@inheritdoc} $0->metatag->offsetUnset()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:186

public offsetGet($offset): mixed {@inheritdoc} $0->metatag->offsetGet()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:193

public offsetSet($offset, $value): void {@inheritdoc} $0->metatag->offsetSet()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200

public appendItem($value = null) {@inheritdoc} $0->metatag->appendItem()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:97

public getItemDefinition() {@inheritdoc} $0->metatag->getItemDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:233

public getIterator(): ArrayIterator {@inheritdoc} $0->metatag->getIterator()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:129

public count(): int {@inheritdoc} $0->metatag->count()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:137

public isEmpty() {@inheritdoc} $0->metatag->isEmpty()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ComputedItemListTrait.php:113

public filter($callback) {@inheritdoc} $0->metatag->filter()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:272

public onChange($delta) {@inheritdoc} $0->metatag->onChange()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:294

public __clone() Magic method: Implements a deep clone. clone $0->metatag

/**
 * Magic method: Implements a deep clone.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:304

public last(): ?Drupal\Core\TypedData\TypedDataInterface {@inheritdoc} $0->metatag->last()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:314

public __construct(Drupal\Core\TypedData\DataDefinitionInterface $definition, $name = null, ?Drupal\Core\TypedData\TypedDataInterface $parent = null) Constructs a TypedData object given its definition and context. new \Drupal\metatag\Plugin\Field\MetatagEntityFieldItemList()

/**
 * Constructs a TypedData object given its definition and context.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   The data definition.
 * @param string $name
 *   (optional) The name of the created property, or NULL if it is the root
 *   of a typed data tree. Defaults to NULL.
 * @param \Drupal\Core\TypedData\TypedDataInterface $parent
 *   (optional) The parent object of the data property, or NULL if it is the
 *   root of a typed data tree. Defaults to NULL.
 *
 * @see \Drupal\Core\TypedData\TypedDataManager::create()
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64

public getPluginId() {@inheritdoc} $0->metatag->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0->metatag->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0->metatag->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0->metatag->validate()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc} $0->metatag->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0->metatag->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0->metatag->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0->metatag->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0->metatag->getParent()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use. $0->metatag->setStringTranslation()

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager. $0->metatag->setTypedDataManager()

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager. $0->metatag->getTypedDataManager()

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

protected ensureComputedValue() Ensures that values are only computed once.

/**
 * Ensures that values are only computed once.
 */

Defined in <drupal>/modules/contrib/metatag/src/TypedData/ComputedItemListTrait.php:28

public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:339
```
public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
```
⇄
Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
iterator_to_array($0->metatag, false)

content_translation_source -> string (3) "und" $0->content_translation_source->value

content_translation_outdated -> string (1) "0" $0->content_translation_outdated->value

body -> Drupal\text\Plugin\Field\FieldType\TextFieldItemList#9041 (0) $0->body

No values
Properties (9)
Methods (69)
Static methods (2)
Iterator

No values uninitialized

protected definition -> Drupal\field\Entity\FieldConfig#2671 (36)

Properties (36)
Methods (125)
Static methods (19)

protected entityTypeId -> string (12) "field_config"
protected enforceIsNew -> null
protected typedData -> null
protected originalEntity -> null
protected cacheContexts -> array (1)
0 => string (28) "languages:language_interface"
protected cacheTags -> array (0)
protected cacheMaxAge -> integer -1
protected _serviceIds -> array (0)
protected _entityStorages -> array (0)
protected originalId -> string (32) "commerce_product.opcionales.body"
protected status -> boolean true
protected uuid -> string (36) "c0dd6217-04d9-43be-a99a-fea8657ddc78"
private isUninstalling -> boolean false
protected langcode -> string (2) "es"
protected third_party_settings -> array (0)
protected _core -> array (0)
protected trustedData -> boolean false
protected dependencies -> array (2)
config => array (3)
0 => string (49) "commerce_product.commerce_product_type.opcionales"
1 => string (35) "field.storage.commerce_product.body"
2 => string (24) "filter.format.basic_html"
module => array (1)
0 => string (4) "text"
protected isSyncing -> boolean false
protected id -> string (32) "commerce_product.opcionales.body"
protected field_name -> string (4) "body"
protected field_type -> string (17) "text_with_summary"
protected entity_type -> string (16) "commerce_product"
protected bundle -> string (10) "opcionales"
protected label -> UTF-8 string (12) "Descripción"
protected description -> string (0) ""
protected settings -> array (3)
display_summary => boolean false
required_summary => boolean false
allowed_formats => array (1)
0 => string (10) "basic_html"
protected required -> boolean false
protected translatable -> boolean true
protected default_value -> array (0)
protected default_value_callback -> null
protected fieldStorage -> null
protected itemDefinition -> null
protected constraints -> array (0)
protected propertyConstraints -> array (0)
protected deleted -> boolean false

public __construct(array $values, $entity_type = 'field_config') Constructs a FieldConfig object.

/**
 * Constructs a FieldConfig object.
 *
 * In most cases, Field entities are created via
 * FieldConfig::create($values), where $values is the same
 * parameter as in this constructor.
 *
 * @param array $values
 *   An array of field properties, keyed by property name. The
 *   storage associated with the field can be specified either with:
 *   - field_storage: the FieldStorageConfigInterface object,
 *   or by referring to an existing field storage in the current configuration
 *   with:
 *   - field_name: The field name.
 *   - entity_type: The entity type.
 *   Additionally, a 'bundle' property is required to indicate the entity
 *   bundle to which the field is attached to. Other array elements will be
 *   used to set the corresponding properties on the class; see the class
 *   property documentation for details.
 * @param string $entity_type
 *   (optional) The entity type on which the field should be created.
 *   Defaults to "field_config".
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:110

public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:143

public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\EntityBase::preSave().

/**
 * Overrides \Drupal\Core\Entity\EntityBase::preSave().
 *
 * @throws \Drupal\Core\Field\FieldException
 *   If the field definition is invalid.
 * @throws \Drupal\Core\Entity\EntityStorageException
 *   In case of failures at the configuration storage level.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:165

public calculateDependencies() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:201

protected linkTemplates() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:264

protected urlRouteParameters($rel) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:280

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:291

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:298

public isDisplayConfigurable($context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:332

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:339

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:347

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:354

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:361

public id() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:200

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:207

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:214

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:221

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:228

public onDependencyRemoval(array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:262

public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:310

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:324

public setLabel($label) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:332

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:340

public setDescription($description) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:348

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:356

public setTranslatable($translatable) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:365

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:373

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:381

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:389

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:401

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:409

public setRequired($required) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:417

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:425

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:442

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:450

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:458

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465

public __sleep(): array Implements the magic __sleep() method.

/**
 * Implements the magic __sleep() method.
 *
 * Using the Serialize interface and serialize() / unserialize() methods
 * breaks entity forms in PHP 5.4.
 *
 * @todo Investigate in https://www.drupal.org/node/1977206.
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578

public setConstraints(array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593

public setPropertyConstraints($name, array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601

public addPropertyConstraints($name, array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629

public getOriginalId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127

public setOriginalId($id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:134

public isNew() Overrides EntityBase::isNew().

/**
 * Overrides EntityBase::isNew().
 *
 * EntityInterface::enforceIsNew() is only supported for newly created
 * configuration entities but has no effect after saving, since each
 * configuration entity is unique.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158

public set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:166

public enable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:184

public disable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:192

public setStatus($status) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:200

public status() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:208

public setUninstalling($uninstalling) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:215

public isUninstalling() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:222

public createDuplicate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:254

protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.

/**
 * Gets the typed config manager.
 *
 * @return \Drupal\Core\Config\TypedConfigManagerInterface
 *   The typed configuration plugin manager.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:290

public toUrl($rel = null, array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:408

public getCacheTagsToInvalidate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:417

protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().

/**
 * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
 *
 * Note that this function should only be called from implementations of
 * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
 * as dependencies are recalculated during every entity save.
 *
 * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:432

public getDependencies() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:446

public getConfigDependencyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:460

public getConfigTarget() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:467

protected invalidateTagsOnSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Override to never invalidate the entity's cache tag; the config system
 * already invalidates it.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509

public setThirdPartySetting($module, $key, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:531

public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:539

public getThirdPartySettings($module) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:551

public unsetThirdPartySetting($module, $key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:558

public getThirdPartyProviders() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:571

public isInstallable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612

public trustData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:619

public hasTrustedData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:627

public save() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:634

protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.

/**
 * Gets the entity type manager.
 *
 * @return \Drupal\Core\Entity\EntityTypeManagerInterface
 *   The entity type manager.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85

protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.

/**
 * Gets the entity type bundle info service.
 *
 * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
 *   The entity type bundle info service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95

protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.

/**
 * Gets the language manager.
 *
 * @return \Drupal\Core\Language\LanguageManagerInterface
 *   The language manager service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105

protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.

/**
 * Gets the UUID generator.
 *
 * @return \Drupal\Component\Uuid\UuidInterface
 *   The UUID service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115

public uuid() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:129

public enforceIsNew($value = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143

public getEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152

public bundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159

public label() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:166

public hasLinkTemplate($rel) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253

public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271

public uriRelationships() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315

public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:337

public language() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:351

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376

public getEntityType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408

public referencedEntities() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:466

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473

protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.

/**
 * The list cache tags to invalidate for this entity.
 *
 * @return string[]
 *   Set of list cache tags.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517

public getTypedData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628

public getConfigDependencyKey() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673

public getOriginal(): ?static {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696

public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:711

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:722

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:734

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:745

public addCacheableDependency($other_object) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15

public addCacheContexts(array $cache_contexts) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32

public addCacheTags(array $cache_tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42

public mergeCacheMaxAge($max_age) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52

protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.

/**
 * Sets cacheability; useful for value object constructors.
 *
 * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
 *   The cacheability to set.
 *
 * @return $this
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39

public traitSleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.

/**
 * Calculates and returns dependencies of a specific plugin instance.
 *
 * Dependencies are added for the module that provides the plugin, as well
 * as any dependencies declared by the instance's calculateDependencies()
 * method, if it implements
 * \Drupal\Component\Plugin\DependentPluginInterface.
 *
 * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
 *   The plugin instance.
 *
 * @return array
 *   An array of dependencies keyed by the type of dependency.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33

protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.

/**
 * Calculates and adds dependencies of a specific plugin instance.
 *
 * Dependencies are added for the module that provides the plugin, as well
 * as any dependencies declared by the instance's calculateDependencies()
 * method, if it implements
 * \Drupal\Component\Plugin\DependentPluginInterface.
 *
 * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
 *   The plugin instance.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88

protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.

/**
 * Wraps the module handler.
 *
 * @return \Drupal\Core\Extension\ModuleHandlerInterface
 *   The module handler.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98

protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.

/**
 * Wraps the theme handler.
 *
 * @return \Drupal\Core\Extension\ThemeHandlerInterface
 *   The theme handler.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108

protected addDependencyTrait($type, $name): $this Adds a dependency.

/**
 * Adds a dependency.
 *
 * @param string $type
 *   Type of dependency being added: 'module', 'theme', 'config', 'content'.
 * @param string $name
 *   If $type is 'module' or 'theme', the name of the module or theme. If
 *   $type is 'config' or 'content', the result of
 *   EntityInterface::getConfigDependencyName().
 *
 * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
 *
 * @return $this
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31

protected addDependencies(array $dependencies) Adds multiple dependencies.

/**
 * Adds multiple dependencies.
 *
 * @param array $dependencies
 *   An array of dependencies keyed by the type of dependency. One example:
 *   @code
 *   [
 *     'module' => [
 *       'node',
 *       'field',
 *       'image',
 *     ],
 *   ];
 *   @endcode
 *
 * @see \Drupal\Core\Entity\DependencyTrait::addDependency
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64

public setSyncing($syncing) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22

public isSyncing() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31

private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.

/**
 * Returns the typed data class name for this entity.
 *
 * @return string
 *   The string representing the typed data class name.
 *
 * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644

public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:211

public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:237

public static Drupal\field\Entity\FieldConfig::loadByName($entity_type_id, $bundle, $field_name): \Drupal\field\FieldConfigInterface|null Loads a field config entity based on the entity type and field name.

/**
 * Loads a field config entity based on the entity type and field name.
 *
 * @param string $entity_type_id
 *   ID of the entity type.
 * @param string $bundle
 *   Bundle name.
 * @param string $field_name
 *   Name of the field.
 *
 * @return \Drupal\field\FieldConfigInterface|null
 *   The field config entity if one exists for the provided field
 *   name, otherwise NULL.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:379

public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491

public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500

public static Drupal\Core\Config\Entity\ConfigEntityBase::sort(Drupal\Core\Config\Entity\ConfigEntityInterface $a, Drupal\Core\Config\Entity\ConfigEntityInterface $b) Callback for uasort() to sort configuration entities by weight and label.

/**
 * Callback for uasort() to sort configuration entities by weight and label.
 */

Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:240

protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Override to never invalidate the individual entities' cache tags; the
 * config system already invalidates them.
 */

Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:519

protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.

/**
 * Gets the configuration manager.
 *
 * @return \Drupal\Core\Config\ConfigManager
 *   The configuration manager.
 */

Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605

public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:435

public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:460

public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:524

public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:534

public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:544

protected static Drupal\Core\Field\FieldConfigBase::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:295

public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:578

public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:453

public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:447

protected static Drupal\Core\Entity\EntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.

/**
 * Invalidates an entity's cache tags upon delete.
 *
 * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
 *   The entity type definition.
 * @param \Drupal\Core\Entity\EntityInterface[] $entities
 *   An array of entities.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582

protected name -> string (4) "body"

protected parent -> Drupal\Core\Entity\Plugin\DataType\EntityAdapter#8497 Blacklisted

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected stringTranslation -> null

protected typedDataManager -> Drupal\Core\TypedData\TypedDataManager#1756 Blacklisted

protected list -> array (0)

protected langcode -> string (2) "es"

public defaultValuesFormValidate(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0->body->defaultValuesFormValidate()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/text/src/Plugin/Field/FieldType/TextFieldItemList.php:16

protected createItem($offset = 0, $value = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:44

public getEntity() {@inheritdoc} $0->body->getEntity()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:51

public setLangcode($langcode) {@inheritdoc} $0->body->setLangcode()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:60

public getLangcode() {@inheritdoc} $0->body->getLangcode()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:67

public getFieldDefinition() {@inheritdoc} $0->body->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:74

public getSettings() {@inheritdoc} $0->body->getSettings()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:81

public getSetting($setting_name) {@inheritdoc} $0->body->getSetting()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:88

public filterEmptyItems() {@inheritdoc} $0->body->filterEmptyItems()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:95

public setValue($values, $notify = true) {@inheritdoc} $0->body->setValue()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:105

public __get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:117

public __set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:127

public __isset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:137

public __unset($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:147

public access($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0->body->access()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:156

public defaultAccess($operation = 'view', ?Drupal\Core\Session\AccountInterface $account = null) {@inheritdoc} $0->body->defaultAccess()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:164

public applyDefaultValue($notify = true) {@inheritdoc} $0->body->applyDefaultValue()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:172

public preSave() {@inheritdoc} $0->body->preSave()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:191

public postSave($update) {@inheritdoc} $0->body->postSave()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:201

public delete() {@inheritdoc} $0->body->delete()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:209

public deleteRevision() {@inheritdoc} $0->body->deleteRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:216

protected delegateMethod($method): array Calls a method on each FieldItem.

/**
 * Calls a method on each FieldItem.
 *
 * Any argument passed will be forwarded to the invoked method.
 *
 * @param string $method
 *   The name of the method to be invoked.
 *
 * @return array
 *   An array of results keyed by delta.
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:231

public view($display_options = array()) {@inheritdoc} $0->body->view()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:245

public generateSampleItems($count = 1) {@inheritdoc} $0->body->generateSampleItems()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:253

public getConstraints() {@inheritdoc} $0->body->getConstraints()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:265

public defaultValuesForm(array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0->body->defaultValuesForm()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:290

public defaultValuesFormSubmit(array $element, array &$form, Drupal\Core\Form\FormStateInterface $form_state) {@inheritdoc} $0->body->defaultValuesFormSubmit()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:327

protected defaultValueWidget(Drupal\Core\Form\FormStateInterface $form_state): \Drupal\Core\Field\WidgetInterface|null Returns the widget object used in default value form.

/**
 * Returns the widget object used in default value form.
 *
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the (entire) configuration form.
 *
 * @return \Drupal\Core\Field\WidgetInterface|null
 *   A Widget object or NULL if no widget is available.
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:352

public equals(Drupal\Core\Field\FieldItemListInterface $list_to_compare) {@inheritdoc} $0->body->equals()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:403

public hasAffectingChanges(Drupal\Core\Field\FieldItemListInterface $original_items, $langcode) {@inheritdoc} $0->body->hasAffectingChanges()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldItemList
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:449

public getValue() {@inheritdoc} $0->body->getValue()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:45

public getString() {@inheritdoc} $0->body->getString()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:94

public get($index) {@inheritdoc} $0->body->get()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:106

public set($index, $value) {@inheritdoc} $0->body->set()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:116

public removeItem($index) {@inheritdoc} $0->body->removeItem()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:138

protected rekey($from_index = 0) Renumbers the items in the list.

/**
 * Renumbers the items in the list.
 *
 * @param int $from_index
 *   Optionally, the index at which to start the renumbering, if it is known
 *   that items before that can safely be skipped (for example, when removing
 *   an item at a given index).
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:158

public first() {@inheritdoc} $0->body->first()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:171

public offsetExists($offset): bool {@inheritdoc} $0->body->offsetExists()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:178

public offsetUnset($offset): void {@inheritdoc} $0->body->offsetUnset()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:186

public offsetGet($offset): mixed {@inheritdoc} $0->body->offsetGet()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:193

public offsetSet($offset, $value): void {@inheritdoc} $0->body->offsetSet()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:200

public appendItem($value = null) {@inheritdoc} $0->body->appendItem()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:213

public getItemDefinition() {@inheritdoc} $0->body->getItemDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:233

public getIterator(): ArrayIterator {@inheritdoc} $0->body->getIterator()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:240

public count(): int {@inheritdoc} $0->body->count()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:247

public isEmpty() {@inheritdoc} $0->body->isEmpty()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:254

public filter($callback) {@inheritdoc} $0->body->filter()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:272

public onChange($delta) {@inheritdoc} $0->body->onChange()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:294

public __clone() Magic method: Implements a deep clone. clone $0->body

/**
 * Magic method: Implements a deep clone.
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:304

public last(): ?Drupal\Core\TypedData\TypedDataInterface {@inheritdoc} $0->body->last()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\Plugin\DataType\ItemList
Defined in <drupal>/core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php:314

/**
 * Constructs a TypedData object given its definition and context.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   The data definition.
 * @param string $name
 *   (optional) The name of the created property, or NULL if it is the root
 *   of a typed data tree. Defaults to NULL.
 * @param \Drupal\Core\TypedData\TypedDataInterface $parent
 *   (optional) The parent object of the data property, or NULL if it is the
 *   root of a typed data tree. Defaults to NULL.
 *
 * @see \Drupal\Core\TypedData\TypedDataManager::create()
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:64

public getPluginId() {@inheritdoc} $0->body->getPluginId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:73

public getPluginDefinition() {@inheritdoc} $0->body->getPluginDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:80

public getDataDefinition() {@inheritdoc} $0->body->getDataDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:87

public validate() {@inheritdoc} $0->body->validate()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:131

public setContext($name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc} $0->body->setContext()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:147

public getName() {@inheritdoc} $0->body->getName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:155

public getRoot() {@inheritdoc} $0->body->getRoot()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:162

public getPropertyPath() {@inheritdoc} $0->body->getPropertyPath()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:173

public getParent() {@inheritdoc} $0->body->getParent()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:195

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected t($string, array $args = array(), array $options = array()): \Drupal\Core\StringTranslation\TranslatableMarkup Translates a string to the current language or to a given language.

/**
 * Translates a string to the current language or to a given language.
 *
 * See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for
 * important security information and usage guidelines.
 *
 * In order for strings to be localized, make them available in one of the
 * ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink. When
 * possible, use the \Drupal\Core\StringTranslation\StringTranslationTrait
 * $this->t(). Otherwise create a new
 * \Drupal\Core\StringTranslation\TranslatableMarkup object.
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $args
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to. See the
 *     @link i18n Internationalization topic @endlink for more information
 *     about string contexts.
 *
 * @return \Drupal\Core\StringTranslation\TranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup::__construct()
 *
 * @ingroup sanitization
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:70

/**
 * Formats a string containing a count of items.
 *
 * @see \Drupal\Core\StringTranslation\TranslationInterface::formatPlural()
 *
 * @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 *   An object that, when cast to a string, returns the translated string.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:83

protected getNumberOfPlurals($langcode = null): int Returns the number of plurals supported by a given language.

/**
 * Returns the number of plurals supported by a given language.
 *
 * @see \Drupal\locale\PluralFormulaInterface::getNumberOfPlurals()
 *
 * @return int
 *   The number of plurals supported.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:95

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:109

public setStringTranslation(Drupal\Core\StringTranslation\TranslationInterface $translation): $this Sets the string translation service to use. $0->body->setStringTranslation()

/**
 * Sets the string translation service to use.
 *
 * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
 *   The string translation service.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php:125

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager. $0->body->setTypedDataManager()

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager. $0->body->getTypedDataManager()

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\TypedData
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\FieldItemList::processDefaultValue($default_value, Drupal\Core\Entity\FieldableEntityInterface $entity, Drupal\Core\Field\FieldDefinitionInterface $definition) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldItemList.php:339
```
public static Drupal\Core\TypedData\TypedData::createInstance($definition, $name = null, ?Drupal\Core\TypedData\TraversableTypedDataInterface $parent = null) {@inheritdoc}
```
/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedData.php:46
```
⇄
Drupal\Core\Field\FieldItemListInterface Iterator Contents uninitialized Blacklisted
iterator_to_array($0->body, false)

protected entityTypeId -> string (16) "commerce_product"

protected enforceIsNew -> null

protected typedData -> null

protected originalEntity -> null

protected cacheContexts -> array (0)

protected cacheTags -> array (0)

protected cacheMaxAge -> integer -1

protected _serviceIds -> array (0)

protected _entityStorages -> array (0)

protected values -> array (14)

product_id => array (1)

x-default => string (1) "6"

type => array (1)

x-default => string (10) "opcionales"

uuid => array (1)

x-default => string (36) "6eb611e5-0c3d-4952-8821-1f90f46f5ffa"

langcode => array (1)

x-default => string (2) "es"

uid => array (1)

x-default => string (1) "2"

status => array (1)

x-default => string (1) "1"

title => array (1)

x-default => string (11) "Extra carga"

created => array (1)

x-default => string (10) "1773827192"

2026-03-18T09:46:32+00:00

changed => array (1)

x-default => string (10) "1773827345"

2026-03-18T09:49:05+00:00

default_langcode => array (1)

x-default => string (1) "1"

content_translation_source => array (1)

x-default => string (3) "und"

content_translation_outdated => array (1)

x-default => string (1) "0"

stores => array (1)

x-default => array (1)

0 => array (1)

target_id => string (1) "1"

variations => array (1)

x-default => array (1)

0 => array (1)

target_id => string (1) "5"

protected fields -> array (0)

protected fieldDefinitions -> array (18)

product_id => Drupal\Core\Field\BaseFieldDefinition#2595 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (6)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2596 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (2) "ID"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * 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 (2) "ID"

read-only => boolean true

provider => string (16) "commerce_product"

field_name => string (10) "product_id"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2597 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (18) "field_item:integer"
settings => array (6)
unsigned => boolean true
size => string (6) "normal"
min => string (0) ""
max => string (0) ""
prefix => string (0) ""
suffix => string (0) ""
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2595 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (7) "integer"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

uuid => Drupal\Core\Field\BaseFieldDefinition#2598 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (6)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2599 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (4) "UUID"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * 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 (4) "UUID"

read-only => boolean true

provider => string (16) "commerce_product"

field_name => string (4) "uuid"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2600 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (15) "field_item:uuid"
settings => array (3)
max_length => integer 128
is_ascii => boolean true
case_sensitive => boolean false
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2598 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (4) "uuid"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

langcode => Drupal\Core\Field\BaseFieldDefinition#2601 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (7)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2602 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (8) "Language"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

label string (6) "Idioma"

display => array (2)

Table (2)
Contents (2)

 options configurable
view array (1) true
form array (2) true

view => array (2)
options => array (1)
region => string (6) "hidden"
configurable => boolean true
form => array (2)
options => array (2)
type => string (15) "language_select"
weight => integer 2
configurable => boolean true

	options	configurable
view	`array` (1)	`true`
form	`array` (2)	`true`

translatable => boolean true

provider => string (16) "commerce_product"

field_name => string (8) "langcode"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2603 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (19) "field_item:language"
settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2601 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (8) "language"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

type => Drupal\Core\Field\BaseFieldDefinition#2604 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (7)

label => string (16) "Tipo de producto"

required => boolean true

read-only => boolean true

provider => string (16) "commerce_product"

field_name => string (4) "type"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2605 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (27) "field_item:entity_reference"
settings => array (3)
target_type => string (21) "commerce_product_type"
handler => string (7) "default"
handler_settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2604 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (16) "entity_reference"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

uid => Drupal\Core\Field\BaseFieldDefinition#2606 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (9)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2607 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (6) "Author"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

label string (5) "Autor"

translatable => boolean true

default_value_callback => string (61) "Drupal\commerce_product\Entity\Product::getDefaultEntityOwner"

description => Drupal\Core\StringTranslation\TranslatableMarkup#2608 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (19) "The product author."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@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 (19) "Autor del producto."

display => array (2)

Table (2)
Contents (2)

 options configurable
view array (1) true
form array (2) true

view => array (2)
options => array (1)
region => string (6) "hidden"
configurable => boolean true
form => array (2)
options => array (2)
type => string (29) "entity_reference_autocomplete"
weight => integer 5
configurable => boolean true

	options	configurable
view	`array` (1)	`true`
form	`array` (2)	`true`

provider => string (16) "commerce_product"

field_name => string (3) "uid"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2609 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (27) "field_item:entity_reference"
settings => array (3)
target_type => string (4) "user"
handler => string (7) "default"
handler_settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2606 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (16) "entity_reference"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * Creates a new field definition based upon a field storage definition.
 *
 * In cases where one needs a field storage definitions to act like full
 * field definitions, this creates a new field definition based upon the
 * (limited) information available. That way it is possible to use the field
 * definition in places where a full field definition is required; e.g., with
 * widgets or formatters.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
 *   The field storage definition to base the new field definition upon.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33

protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.

/**
 * Creates a new list definition.
 *
 * @param string $item_type
 *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new List Data Definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26

public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1

status => Drupal\Core\Field\BaseFieldDefinition#2610 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (9)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2611 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (9) "Published"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * 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 (9) "Publicado"

revisionable => boolean true

translatable => boolean true

default_value => array (1)

0 => array (1)

value => boolean true

display => array (1)

form => array (2)

options => array (3)

type => string (16) "boolean_checkbox"

settings => array (1) Depth Limit

weight => integer 90

configurable => boolean true

provider => string (16) "commerce_product"

field_name => string (6) "status"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2612 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)

type => string (18) "field_item:boolean"

settings => array (2)

on_label => Drupal\Core\StringTranslation\TranslatableMarkup#2613 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (2) "On"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

on_label string (8) "Activado"

off_label => Drupal\Core\StringTranslation\TranslatableMarkup#2614 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (3) "Off"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

off_label string (11) "Desactivado"

protected typedDataManager -> null

protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2610 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (7) "boolean"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

stores => Drupal\Core\Field\BaseFieldDefinition#2615 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (9)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2616 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (6) "Stores"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@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 (7) "Tiendas"

description => Drupal\Core\StringTranslation\TranslatableMarkup#2617 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (19) "The product stores."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@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 (19) "The product stores."

required => boolean true

cardinality => integer -1

display => array (2)

Table (2)
Contents (2)

 options configurable
form array (2) true
view array (1) true

form => array (2)
options => array (2)
type => string (22) "commerce_entity_select"
weight => integer -10
configurable => boolean true
view => array (2)
options => array (1)
region => string (6) "hidden"
configurable => boolean true

	options	configurable
form	`array` (2)	`true`
view	`array` (1)	`true`

provider => string (16) "commerce_product"

field_name => string (6) "stores"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2618 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (27) "field_item:entity_reference"
settings => array (3)
target_type => string (14) "commerce_store"
handler => string (7) "default"
handler_settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2615 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (16) "entity_reference"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

title => Drupal\Core\Field\BaseFieldDefinition#2619 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (9)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2620 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (5) "Title"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

label UTF-8 string (7) "Título"

description => Drupal\Core\StringTranslation\TranslatableMarkup#2621 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (18) "The product title."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

description UTF-8 string (24) "El título del producto."

required => boolean true

translatable => boolean true

display => array (2)

Table (2)
Contents (2)

 options configurable
view array (3) true
form array (2) true

view => array (2)
options => array (3)
label => string (6) "hidden"
type => string (6) "string"
weight => integer -5
configurable => boolean true
form => array (2)
options => array (2)
type => string (16) "string_textfield"
weight => integer -5
configurable => boolean true

	options	configurable
view	`array` (3)	`true`
form	`array` (2)	`true`

provider => string (16) "commerce_product"

field_name => string (5) "title"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2622 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (17) "field_item:string"
settings => array (4)
max_length => integer 255
is_ascii => boolean false
case_sensitive => boolean false
default_value => string (0) ""
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2619 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}
 */

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

/**
 * 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

variations => Drupal\Core\Field\BaseFieldDefinition#2663 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (9)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2664 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (10) "Variations"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

label string (11) "Variaciones"

description => Drupal\Core\StringTranslation\TranslatableMarkup#2665 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (23) "The product variations."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@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 (29) "Las variaciones de productos."

required => boolean true

cardinality => integer -1

display => array (2)

Table (2)
Contents (2)

 options configurable
view array (2) true
form array (1) true

view => array (2)
options => array (2)
type => string (20) "commerce_add_to_cart"
weight => integer 10
configurable => boolean true
form => array (2)
options => array (1)
region => string (6) "hidden"
configurable => boolean true

	options	configurable
view	`array` (2)	`true`
form	`array` (1)	`true`

provider => string (16) "commerce_product"

field_name => string (10) "variations"

entity_type => string (16) "commerce_product"

bundle => string (10) "opcionales"

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2666 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (27) "field_item:entity_reference"
settings => array (3)
target_type => string (26) "commerce_product_variation"
handler => string (7) "default"
handler_settings => array (1)
target_bundles => array (1) Depth Limit
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2663 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (16) "entity_reference"

protected propertyDefinitions -> null

protected schema -> array (4)

columns => array (1)

target_id => array (3)

description => string (28) "The ID of the target entity."

type => string (3) "int"

unsigned => boolean true

indexes => array (1)

target_id => array (1)

0 => string (9) "target_id"

unique keys => array (0)

foreign keys => array (0)

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:74

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:15

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:22

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Cache/UnchangingCacheableDependencyTrait.php:29

public static Drupal\Core\Field\BaseFieldDefinition::create($type): static Creates a new field definition.

/**
 * Creates a new field definition.
 *
 * @param string $type
 *   The type of the field.
 *
 * @return static
 *   A new field definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:57

/**
 * 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

default_variation => Drupal\Core\Field\BaseFieldDefinition#2667 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2668 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (17) "Default variation"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

label UTF-8 string (22) "Variación por defecto"

description => Drupal\Core\StringTranslation\TranslatableMarkup#2669 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (22) "The default variation."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

description UTF-8 string (26) "La variación por defecto."

computed => boolean true

cardinality => integer 1

class => string (61) "Drupal\commerce_product\Plugin\Field\ComputedDefaultVariation"

display => array (2)

Table (2)
Contents (2)

 options configurable
form array (1) false
view array (1) false

form => array (2)
options => array (1)
region => string (6) "hidden"
configurable => boolean false
view => array (2)
options => array (1)
region => string (6) "hidden"
configurable => boolean false

	options	configurable
form	`array` (1)	`false`
view	`array` (1)	`false`

provider => string (16) "commerce_product"

field_name => string (17) "default_variation"

entity_type => string (16) "commerce_product"

bundle => string (10) "opcionales"

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2670 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (27) "field_item:entity_reference"
settings => array (3)
target_type => string (26) "commerce_product_variation"
handler => string (7) "default"
handler_settings => array (1)
target_bundles => array (1) Depth Limit
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2667 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (16) "entity_reference"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

path => Drupal\Core\Field\BaseFieldDefinition#2631 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (9)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2632 (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

/**
 * 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#2633 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (22) "The product URL alias."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@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 (27) "Alias del URL del producto."

translatable => boolean true

display => array (1)

form => array (2)

options => array (2)

type => string (4) "path"

weight => integer 30

configurable => boolean true

computed => boolean true

provider => string (16) "commerce_product"

field_name => string (4) "path"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2634 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (15) "field_item:path"
settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2631 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (4) "path"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * Creates a new field definition based upon a field storage definition.
 *
 * In cases where one needs a field storage definitions to act like full
 * field definitions, this creates a new field definition based upon the
 * (limited) information available. That way it is possible to use the field
 * definition in places where a full field definition is required; e.g., with
 * widgets or formatters.
 *
 * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition
 *   The field storage definition to base the new field definition upon.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:83

public static Drupal\Core\Field\BaseFieldDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:101

public static Drupal\Core\TypedData\ListDataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:33

protected static Drupal\Core\Field\BaseFieldDefinition::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

public static Drupal\Core\TypedData\ListDataDefinition::create($item_type): static Creates a new list definition.

/**
 * Creates a new list definition.
 *
 * @param string $item_type
 *   The data type of the list items; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new List Data Definition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:26

public static Drupal\Core\TypedData\ListDataDefinition::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:43

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

public const Drupal\Core\Field\FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED :: integer -1

created => Drupal\Core\Field\BaseFieldDefinition#2635 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (8)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2636 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (7) "Created"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

label string (6) "Creado"

description => Drupal\Core\StringTranslation\TranslatableMarkup#2637 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (38) "The time when the product was created."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@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 (41) "La fecha en la que el producto fue creado"

translatable => boolean true

display => array (2)

Table (2)
Contents (2)

 options configurable
form array (2) true
view array (1) true

form => array (2)
options => array (2)
type => string (18) "datetime_timestamp"
weight => integer 10
configurable => boolean true
view => array (2)
options => array (1)
region => string (6) "hidden"
configurable => boolean true

	options	configurable
form	`array` (2)	`true`
view	`array` (1)	`true`

provider => string (16) "commerce_product"

field_name => string (7) "created"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2638 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (18) "field_item:created"
settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2635 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (7) "created"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

changed => Drupal\Core\Field\BaseFieldDefinition#2639 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (7)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2640 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (7) "Changed"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * 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 (10) "Modificado"

description => Drupal\Core\StringTranslation\TranslatableMarkup#2641 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (42) "The time when the product was last edited."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

description UTF-8 string (60) "La fecha en la que el producto se modificó por última vez."

translatable => boolean true

provider => string (16) "commerce_product"

field_name => string (7) "changed"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2642 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (18) "field_item:changed"
settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2639 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (7) "changed"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

default_langcode => Drupal\Core\Field\BaseFieldDefinition#2643 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (9)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2644 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (19) "Default translation"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

label UTF-8 string (26) "Traducción predeterminada"

description => Drupal\Core\StringTranslation\TranslatableMarkup#2645 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (58) "A flag indicating whether this is the default translation."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

description UTF-8 string (61) "Una marca indicando si esta es la traducción predeterminada."

translatable => boolean true

revisionable => boolean true

default_value => array (1)

0 => array (1)

value => boolean true

provider => string (16) "commerce_product"

field_name => string (16) "default_langcode"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2646 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)

type => string (18) "field_item:boolean"

settings => array (2)

on_label => Drupal\Core\StringTranslation\TranslatableMarkup#2647 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (2) "On"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

on_label string (8) "Activado"

off_label => Drupal\Core\StringTranslation\TranslatableMarkup#2648 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (3) "Off"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

off_label string (11) "Desactivado"

protected typedDataManager -> null

protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2643 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (7) "boolean"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

metatag => Drupal\Core\Field\BaseFieldDefinition#2649 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2650 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (40) "Metatags (Hidden field for JSON support)"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

label string (40) "Metatags (Hidden field for JSON support)"

description => Drupal\Core\StringTranslation\TranslatableMarkup#2651 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (38) "The computed meta tags for the entity."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

description string (38) "The computed meta tags for the entity."

computed => boolean true

translatable => boolean true

read-only => boolean true

entity_type => string (16) "commerce_product"

cardinality => integer -1

provider => string (7) "metatag"

field_name => string (7) "metatag"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2652 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (27) "field_item:metatag_computed"
settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2649 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (16) "metatag_computed"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

content_translation_source => Drupal\Core\Field\BaseFieldDefinition#2653 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2654 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (18) "Translation source"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

label UTF-8 string (24) "Origen de la traducción"

description => Drupal\Core\StringTranslation\TranslatableMarkup#2655 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (60) "The source language from which this translation was created."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

description UTF-8 string (59) "El idioma fuente para el que se ha creado esta traducción."

default_value => array (1)

0 => array (1)

value => string (3) "und"

initial_value => array (1)

0 => array (1)

value => string (3) "und"

revisionable => boolean true

translatable => boolean true

provider => string (19) "content_translation"

field_name => string (26) "content_translation_source"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2656 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)
type => string (19) "field_item:language"
settings => array (0)
protected typedDataManager -> null
protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2653 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (8) "language"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

content_translation_outdated => Drupal\Core\Field\BaseFieldDefinition#2657 (7)

Properties (7)
Methods (89)
Static methods (9)
Class constants (1)

protected definition -> array (10)

label => Drupal\Core\StringTranslation\TranslatableMarkup#2658 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (20) "Translation outdated"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

label UTF-8 string (21) "Traducción anticuada"

description => Drupal\Core\StringTranslation\TranslatableMarkup#2659 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (66) "A boolean indicating whether this translation needs to be updated."
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> 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", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

description UTF-8 string (76) "Un valor booleano que indica si esta traducción necesita o no actualizarse."

default_value => array (1)

0 => array (1)

value => boolean false

initial_value => array (1)

0 => array (1)

value => boolean false

revisionable => boolean true

translatable => boolean true

provider => string (19) "content_translation"

field_name => string (28) "content_translation_outdated"

entity_type => string (16) "commerce_product"

bundle => null

protected typedDataManager -> null

protected itemDefinition -> Drupal\Core\Field\TypedData\FieldItemDataDefinition#2660 (3)

Properties (3)
Methods (39)
Static methods (4)

protected definition -> array (2)

type => string (18) "field_item:boolean"

settings => array (2)

on_label => Drupal\Core\StringTranslation\TranslatableMarkup#2661 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (2) "On"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

on_label string (8) "Activado"

off_label => Drupal\Core\StringTranslation\TranslatableMarkup#2662 (5)

Properties (5)
Methods (12)
Static methods (2)
toString

protected string -> string (3) "Off"
protected arguments -> array (0)
protected translatedMarkup -> null
protected options -> array (0)
protected stringTranslation -> null

/**
 * Constructs a new class instance.
 *
 * When possible, use the
 * \Drupal\Core\StringTranslation\StringTranslationTrait $this->t(). Otherwise
 * create a new \Drupal\Core\StringTranslation\TranslatableMarkup object
 * directly.
 *
 * Calling the trait's t() method or instantiating a new TranslatableMarkup
 * object serves two purposes:
 * - At run-time it translates user-visible text into the appropriate
 *   language.
 * - Static analyzers detect calls to t() and new TranslatableMarkup, and add
 *   the first argument (the string to be translated) to the database of
 *   strings that need translation. These strings are expected to be in
 *   English, so the first argument should always be in English.
 * To allow the site to be localized, it is important that all human-readable
 * text that will be displayed on the site or sent to a user is made available
 * in one of the ways supported by the
 * @link https://www.drupal.org/node/322729 Localization API @endlink.
 * See the @link https://www.drupal.org/node/322729 Localization API @endlink
 * pages for more information, including recommendations on how to break up or
 * not break up strings for translation.
 *
 * @section sec_translating_vars Translating Variables
 * $string should always be an English literal string.
 *
 * $string should never contain a variable, such as:
 * @code
 * new TranslatableMarkup($text)
 * @endcode
 * There are several reasons for this:
 * - Using a variable for $string that is user input is a security risk.
 * - Using a variable for $string that has even guaranteed safe text (for
 *   example, user interface text provided literally in code), will not be
 *   picked up by the localization static text processor. (The parameter could
 *   be a variable if the entire string in $text has been passed into t() or
 *   new TranslatableMarkup() elsewhere as the first argument, but that
 *   strategy is not recommended.)
 *
 * It is especially important never to call new TranslatableMarkup($user_text)
 * or t($user_text) where $user_text is some text that a user entered -- doing
 * that can lead to cross-site scripting and other security problems. However,
 * you can use variable substitution in your string, to put variable text such
 * as user names or link URLs into translated text. Variable substitution
 * looks like this:
 * @code
 * new TranslatableMarkup("@name's blog", ['@name' => $account->getDisplayName()]);
 * @endcode
 * Basically, you can put placeholders like @name into your string, and the
 * method will substitute the sanitized values at translation time. (See the
 * Localization API pages referenced above and the documentation of
 * \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * for details about how to safely and correctly define variables in your
 * string.) Translators can then rearrange the string as necessary for the
 * language (e.g., in Spanish, it might be "blog de @name").
 *
 * @param string $string
 *   A string containing the English text to translate.
 * @param array $arguments
 *   (optional) An associative array of replacements to make after
 *   translation. Based on the first character of the key, the value is
 *   escaped and/or themed. See
 *   \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for
 *   details.
 * @param array $options
 *   (optional) An associative array of additional options, with the following
 *   elements:
 *   - 'langcode' (defaults to the current language): A language code, to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source
 *     string belongs to.
 * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
 *   (optional) The string translation service.
 *
 * @throws \InvalidArgumentException
 *   Exception thrown when $string is not a string.
 *
 * @see \Drupal\Component\Render\FormattableMarkup::placeholderFormat()
 * @see \Drupal\Core\StringTranslation\StringTranslationTrait::t()
 *
 * @ingroup sanitization
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:129

public getUntranslatedString(): string Gets the untranslated string value stored in this translated string.

/**
 * Gets the untranslated string value stored in this translated string.
 *
 * @return string
 *   The string stored in this wrapper.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:145

public getOption($name): mixed Gets a specific option from this translated string.

/**
 * Gets a specific option from this translated string.
 *
 * @param string $name
 *   Option name.
 *
 * @return mixed
 *   The value of this option or empty string of option is not set.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:158

public getOptions(): mixed[] Gets all options from this translated string.

/**
 * Gets all options from this translated string.
 *
 * @return mixed[]
 *   The array of options.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:168

public getArguments(): mixed[] Gets all arguments from this translated string.

/**
 * Gets all arguments from this translated string.
 *
 * @return mixed[]
 *   The array of arguments.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:178

public render(): string Renders the object as a string.

/**
 * Renders the object as a string.
 *
 * @return string
 *   The translated string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:188

public __sleep(): array Magic __sleep() method to avoid serializing the string translator.

/**
 * Magic __sleep() method to avoid serializing the string translator.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:203

protected getStringTranslation(): \Drupal\Core\StringTranslation\TranslationInterface Gets the string translation service.

/**
 * Gets the string translation service.
 *
 * @return \Drupal\Core\StringTranslation\TranslationInterface
 *   The string translation service.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:213

public count(): int Returns the string length.

/**
 * Returns the string length.
 *
 * @return int
 *   The length of the string.
 */

Defined in <drupal>/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php:227

public __toString(): string Implements the magic __toString() method.

/**
 * Implements the magic __toString() method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:13

public jsonSerialize(): string Returns a representation of the object for use in JSON serialization.

/**
 * Returns a representation of the object for use in JSON serialization.
 *
 * @return string
 *   The safe string content.
 */

Inherited from Drupal\Component\Render\FormattableMarkup
Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:97

protected _die() For test purposes, wrap die() in an overridable method.

/**
 * For test purposes, wrap die() in an overridable method.
 */

Defined in <drupal>/core/lib/Drupal/Component/Utility/ToStringTrait.php:31

protected static Drupal\Component\Render\FormattableMarkup::placeholderFormat($string, array $args): string Replaces placeholders in a string with values.

/**
 * Replaces placeholders in a string with values.
 *
 * For convenience examples are listed here. Refer to the parameter
 * description for $args for details of the placeholders "@", "%", and ":".
 *
 * Secure examples.
 * @code
 * // Return the HTML string "Prefix $some_variable".
 * $this->placeholderFormat('Prefix @foo', ['@foo' => $some_variable]);
 * // Convert an object to a sanitized string.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => (string) $safe_string_interface_object]);
 * // Wrap $some_variable in an <em> tag.
 * $this->placeholderFormat('Prefix %foo', ['%foo' => $some_variable]);
 * // The following are using the : placeholder inside an HTML tag.
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo" title="static text">link text</a>', [':foo' => $some_variable]);
 * $this->placeholderFormat('<a href=":foo">link text</a>', [':foo' => $some_variable]);
 * // Use a : placeholder inside an HTML tag.
 * $this->placeholderFormat('<img src=":foo" />', [':foo' => '/image.png']);
 * @endcode
 * The above are typical examples of using the placeholders correctly.
 *
 * Insecure examples.
 * @code
 * // The following are using the @ placeholder inside an HTML tag.
 * $this->placeholderFormat('<@foo>text</@foo>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a @foo>link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a href="@foo">link text</a>', ['@foo' => $some_variable]);
 * $this->placeholderFormat('<a title="@foo">link text</a>', ['@foo' => $some_variable]);
 * // Implicitly convert an object to a string, which is not sanitized.
 * $this->placeholderFormat('Non-sanitized replacement value: @foo', ['@foo' => $safe_string_interface_object]);
 * @endcode
 * These are the more common mistakes that can be made. Make sure that your
 * site is not using any insecure usages of these placeholders.
 *
 * @param string $string
 *   A string containing placeholders. The string itself is expected to be
 *   safe and correct HTML. Any unsafe content must be in $args and inserted
 *   via placeholders. It is insecure to use the @ or % placeholders within
 *   the "<"  and ">" of an HTML tag.
 * @param array $args
 *   An associative array of replacements. Each array key should be the same
 *   as a placeholder in $string. The corresponding value should be a string
 *   or an object that implements \Drupal\Component\Render\MarkupInterface.
 *   The args[] value replaces the placeholder in $string. Sanitization and
 *   formatting will be done before replacement. The type of sanitization
 *   and formatting depends on the first character of the key:
 *   - @variable: Use as the default choice for anything displayed on the
 *     site. Do not use within the "<" and ">" of an HTML tag, such as in
 *     HTML attribute values. Doing so is a security risk.
 *   - %variable: Use when @variable would be appropriate, but you want the
 *     placeholder value to be wrapped in an <em> tag with a placeholder
 *     class. As with @variable, do not use within the "<" and ">" of an HTML
 *     tag, such as in HTML attribute values. Doing so is a security risk.
 *   - :variable: Use when the return value is to be used as a URL value of an
 *     HTML attribute. Only the "href" attribute is supported. The return
 *     value is escaped with
 *     \Drupal\Component\Utility\Html::escape() and filtered for dangerous
 *     protocols using UrlHelper::stripDangerousProtocols(). Use this when
 *     using the "href" attribute, ensuring the value is always wrapped in
 *     quotes.
 *
 * @return string
 *   A formatted HTML string with the placeholders replaced.
 *
 * @ingroup sanitization
 *
 * @see \Drupal\Core\StringTranslation\TranslatableMarkup
 * @see \Drupal\Core\StringTranslation\PluralTranslatableMarkup
 * @see \Drupal\Component\Utility\Html::escape()
 * @see \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols()
 * @see \Drupal\Core\Url::fromUri()
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:175

protected static Drupal\Component\Render\FormattableMarkup::placeholderEscape($value): string Escapes a placeholder replacement value if needed.

/**
 * Escapes a placeholder replacement value if needed.
 *
 * @param string|\Drupal\Component\Render\MarkupInterface $value
 *   A placeholder replacement value.
 *
 * @return string
 *   The properly escaped replacement value.
 */

Defined in <drupal>/core/lib/Drupal/Component/Render/FormattableMarkup.php:237

off_label string (11) "Desactivado"

protected typedDataManager -> null

protected fieldDefinition -> Drupal\Core\Field\BaseFieldDefinition#2657 Recursion

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:57

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:64

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:71

public getFieldDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:78

public setFieldDefinition($field_definition) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:85

public getLabel(): string Gets the label of the field type.

/**
 * Gets the label of the field type.
 *
 * If the label hasn't been set, then fall back to the label of the
 * typed data definition.
 *
 * @return string
 *   The label of the field type.
 *
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:101

public __construct(array $values = array()) Constructs a new data definition object.

/**
 * Constructs a new data definition object.
 *
 * @param array $values
 *   (optional) If given, an array of initial values to set on the definition.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:46

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:53

public setDataType($type): static Sets the data type.

/**
 * Sets the data type.
 *
 * @param string $type
 *   The data type to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:66

public setLabel($label): static Sets the human-readable label.

/**
 * Sets the human-readable label.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
 *   The label to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:87

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:95

public setDescription($description): static Sets the human-readable description.

/**
 * Sets the human-readable description.
 *
 * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
 *   The description to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:108

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:116

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:123

public setReadOnly($read_only): static Sets whether the data is read-only.

/**
 * Sets whether the data is read-only.
 *
 * @param bool $read_only
 *   Whether the data is read-only.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:140

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:148

public setComputed($computed): static Sets whether the data is computed.

/**
 * Sets whether the data is computed.
 *
 * @param bool $computed
 *   Whether the data is computed.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:161

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:169

public setRequired($required): static Sets whether the data is required.

/**
 * Sets whether the data is required.
 *
 * @param bool $required
 *   Whether the data is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:182

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:190

public setClass($class): static Sets the class used for creating the typed data object.

/**
 * Sets the class used for creating the typed data object.
 *
 * @param string|null $class
 *   The class to use.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:209

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:217

public setSettings(array $settings): static Sets the array of settings, as required by the used class.

/**
 * Sets the array of settings, as required by the used class.
 *
 * @param array $settings
 *   The array of settings.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:230

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:238

public setSetting($setting_name, $value): static Sets a definition setting.

/**
 * Sets a definition setting.
 *
 * @param string $setting_name
 *   The definition setting to set.
 * @param mixed $value
 *   The value to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:253

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:261

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:283

public setConstraints(array $constraints): $this Sets an array of validation constraints.

/**
 * Sets an array of validation constraints.
 *
 * @param array $constraints
 *   An array of validation constraint definitions, keyed by constraint name.
 *   Each constraint definition can be used for instantiating
 *   \Symfony\Component\Validator\Constraint objects.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:298

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:306

public offsetExists($offset): bool {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:318

public & offsetGet($offset): mixed {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:331

public offsetSet($offset, $value): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:345

public offsetUnset($offset): void {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * This is for BC support only.
 *
 * @todo Remove in https://www.drupal.org/node/1928868.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:356

public toArray(): array Returns all definition values as array.

/**
 * Returns all definition values as array.
 *
 * @return array
 *   The array holding values for all definition keys.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:366

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:373

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:383

public setInternal($internal): $this Sets the whether the data value should be internal.

/**
 * Sets the whether the data value should be internal.
 *
 * @param bool $internal
 *   Whether the data value should be internal.
 *
 * @return $this
 *
 * @see \Drupal\Core\TypedData\DataDefinitionInterface::isInternal
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:401

public setTypedDataManager(Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager): $this Sets the typed data manager.

/**
 * Sets the typed data manager.
 *
 * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
 *   The typed data manager.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:25

public getTypedDataManager(): \Drupal\Core\TypedData\TypedDataManagerInterface Gets the typed data manager.

/**
 * Gets the typed data manager.
 *
 * @return \Drupal\Core\TypedData\TypedDataManagerInterface
 *   The typed data manager.
 */

Inherited from Drupal\Core\TypedData\DataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/TypedDataTrait.php:36

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::createFromDataType($data_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:28

public static Drupal\Core\Field\TypedData\FieldItemDataDefinition::create($field_definition): static Creates a new field item definition.

/**
 * Creates a new field item definition.
 *
 * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
 *   The field definition the item definition belongs to.
 *
 * @return static
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php:47

public static Drupal\Core\TypedData\DataDefinition::create($type): static Creates a new data definition.

/**
 * Creates a new data definition.
 *
 * @param string $type
 *   The data type of the data; e.g., 'string', 'integer' or 'any'.
 *
 * @return static
 *   A new DataDefinition object.
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:28

public static Drupal\Core\TypedData\DataDefinition::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/TypedData/DataDefinition.php:36

protected type -> string (7) "boolean"

protected propertyDefinitions -> null

protected schema -> null

protected indexes -> array (0)

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:110

public setName($name): static Sets the field name.

/**
 * Sets the field name.
 *
 * @param string $name
 *   The field name to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:123

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:131

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:138

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Note that the method does not unset existing settings not specified in the
 * incoming $settings array.
 *
 * For example:
 * @code
 *   // Given these are the default settings.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'apple',
 *     'season' => 'summer',
 *   ];
 *   // Change only the 'fruit' setting.
 *   $field_definition->setSettings(['fruit' => 'banana']);
 *   // The 'season' setting persists unchanged.
 *   $field_definition->getSettings() === [
 *     'fruit' => 'banana',
 *     'season' => 'summer',
 *   ];
 * @endcode
 *
 * For clarity, it is preferred to use setSetting() if not all available
 * settings are supplied.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:167

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:179

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:186

public getProvider() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:194

public setProvider($provider): $this Sets the name of the provider of this field.

/**
 * Sets the name of the provider of this field.
 *
 * @param string $provider
 *   The provider name to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:206

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:214

public setTranslatable($translatable): $this Sets whether the field is translatable.

/**
 * Sets whether the field is translatable.
 *
 * @param bool $translatable
 *   Whether the field is translatable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:227

public isRevisionable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:235

public setRevisionable($revisionable): $this Sets whether the field is revisionable.

/**
 * Sets whether the field is revisionable.
 *
 * @param bool $revisionable
 *   Whether the field is revisionable.
 *
 * @return $this
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:250

public getCardinality() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:258

public setCardinality($cardinality): $this Sets the maximum number of items allowed for the field.

/**
 * Sets the maximum number of items allowed for the field.
 *
 * Possible values are positive integers or
 * FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED.
 *
 * Note that if the entity type that this base field is attached to is
 * revisionable and the field has a cardinality higher than 1, the field is
 * considered revisionable by default.
 *
 * @param int $cardinality
 *   The field cardinality.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:278

public isMultiple() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:286

public setPropertyConstraints($name, array $constraints): static Sets constraints for a given field item property.

/**
 * Sets constraints for a given field item property.
 *
 * Note: this overwrites any existing property constraints. If you need to
 * add to the existing constraints, use
 * \Drupal\Core\Field\BaseFieldDefinition::addPropertyConstraints()
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:306

public addPropertyConstraints($name, array $constraints): static Adds constraints for a given field item property.

/**
 * Adds constraints for a given field item property.
 *
 * Adds a constraint to a property of a base field item. e.g.
 * @code
 * // Limit the field item's value property to the range 0 through 10.
 * // e.g. $node->size->value.
 * $field->addPropertyConstraints('value', [
 *   'Range' => [
 *     'min' => 0,
 *     'max' => 10,
 *   ]
 * ]);
 * @endcode
 *
 * If you want to add a validation constraint that applies to the
 * \Drupal\Core\Field\FieldItemList, use BaseFieldDefinition::addConstraint()
 * instead.
 *
 * Note: passing a new set of options for an existing property constraint will
 * overwrite with the new options.
 *
 * @param string $name
 *   The name of the property to set constraints for.
 * @param array $constraints
 *   The constraints to set.
 *
 * @return static
 *   The object itself for chaining.
 *
 * @see \Drupal\Core\Field\BaseFieldDefinition::addConstraint()
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:345

public setDisplayOptions($display_context, array $options): static Sets the display options for the field in forms or rendered entities.

/**
 * Sets the display options for the field in forms or rendered entities.
 *
 * This enables generic rendering of the field with widgets / formatters,
 * including automated support for "In place editing", and with optional
 * configurability in the "Manage display" / "Manage form display" UI screens.
 *
 * Unless this method is called, the field remains invisible (or requires
 * ad-hoc rendering logic).
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param array $options
 *   An array of display options. Refer to
 *   \Drupal\Core\Field\FieldDefinitionInterface::getDisplayOptions() for
 *   a list of supported keys. The options should include at least a 'weight',
 *   or specify 'region' = 'hidden'. The 'default_widget' /
 *   'default_formatter' for the field type will be used if no 'type' is
 *   specified.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:381

public setDisplayConfigurable($display_context, $configurable): static Sets whether the display for the field can be configured.

/**
 * Sets whether the display for the field can be configured.
 *
 * @param string $display_context
 *   The display context. Either 'view' or 'form'.
 * @param bool $configurable
 *   Whether the display options can be configured (e.g., via the "Manage
 *   display" / "Manage form display" UI screens). If TRUE, the options
 *   specified via getDisplayOptions() act as defaults.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:399

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:411

public isDisplayConfigurable($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:418

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:425

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:432

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:439

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:456

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:476

public getInitialValue(): array Returns the initial value for the field.

/**
 * Returns the initial value for the field.
 *
 * @return array
 *   The initial value for the field, as a numerically indexed array of items,
 *   each item being a property/value array. An empty array when there is no
 *   default value.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:492

public setInitialValue($value): $this Sets an initial value for the field.

/**
 * Sets an initial value for the field.
 *
 * @param mixed $value
 *   The initial value for the field. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:511

public getInitialValueFromField(): string|null Returns the name of the field that will be used for getting initial values.

/**
 * Returns the name of the field that will be used for getting initial values.
 *
 * @return string|null
 *   The field name.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:528

public setInitialValueFromField($field_name, $default_value = null): $this Sets a field that will be used for getting initial values.

/**
 * Sets a field that will be used for getting initial values.
 *
 * @param string $field_name
 *   The name of the field that will be used for getting initial values.
 * @param mixed $default_value
 *   (optional) The default value for the field, in case the inherited value
 *   is NULL. This can be either:
 *   - a literal, in which case it will be assigned to the first property of
 *     the first item;
 *   - a numerically indexed array of items, each item being a property/value
 *     array;
 *   - a non-numerically indexed array, in which case the array is assumed to
 *     be a property/value array and used as the first item;
 *   - an empty array for no initial value.
 *   If the field being added is required or an entity key, it is recommended
 *   to provide a default value.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:552

public getOptionsProvider($property_name, Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:561

public getPropertyDefinition($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:576

public getPropertyDefinitions() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:591

public getPropertyNames() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:602

public getMainPropertyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:609

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:617

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:627

public setTargetEntityTypeId($entity_type_id): $this Sets the ID of the type of the entity this field is attached to.

/**
 * Sets the ID of the type of the entity this field is attached to.
 *
 * @param string $entity_type_id
 *   The name of the target entity type to set.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:639

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:647

public setTargetBundle($bundle): $this Sets the bundle this field is defined for.

/**
 * Sets the bundle this field is defined for.
 *
 * @param string|null $bundle
 *   The bundle, or NULL if the field is not bundle-specific.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:659

public getSchema() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:667

public getColumns() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:694

public hasCustomStorage() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:702

public isBaseField() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:709

public setCustomStorage($custom_storage): $this Sets the storage behavior for this field.

/**
 * Sets the storage behavior for this field.
 *
 * @param bool $custom_storage
 *   Pass FALSE if the storage takes care of storing the field,
 *   TRUE otherwise.
 *
 * @return $this
 *
 * @throws \LogicException
 *   Thrown if custom storage is to be set to FALSE for a computed field.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:725

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:736

public getUniqueStorageIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:743

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:750

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:763

public setDeleted($deleted): $this Sets whether the field storage is deleted.

/**
 * Sets whether the field storage is deleted.
 *
 * @param bool $deleted
 *   Whether the field storage is deleted.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:775

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:783

public isStorageRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:794

public setStorageRequired($required): static Sets whether the field storage is required.

/**
 * Sets whether the field storage is required.
 *
 * @param bool $required
 *   Whether the field storage is required.
 *
 * @return static
 *   The object itself for chaining.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:812

public __clone() Magic method: Implements a deep clone.

/**
 * Magic method: Implements a deep clone.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:820

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/BaseFieldDefinition.php:837

public __construct(array $values = array(), ?Drupal\Core\TypedData\DataDefinitionInterface $item_definition = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:50

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:58

public setDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:65

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:74

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:92

public setItemDefinition(Drupal\Core\TypedData\DataDefinitionInterface $definition): $this Sets the item definition.

/**
 * Sets the item definition.
 *
 * @param \Drupal\Core\TypedData\DataDefinitionInterface $definition
 *   A list item's data definition.
 *
 * @return $this
 */

Inherited from Drupal\Core\TypedData\ListDataDefinition
Defined in <drupal>/core/lib/Drupal/Core/TypedData/ListDataDefinition.php:104

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

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

/**
 * 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

body => Drupal\field\Entity\FieldConfig#2671 (36)

Properties (36)
Methods (125)
Static methods (19)

protected entityTypeId -> string (12) "field_config"
protected enforceIsNew -> null
protected typedData -> null
protected originalEntity -> null
protected cacheContexts -> array (1)
0 => string (28) "languages:language_interface"
protected cacheTags -> array (0)
protected cacheMaxAge -> integer -1
protected _serviceIds -> array (0)
protected _entityStorages -> array (0)
protected originalId -> string (32) "commerce_product.opcionales.body"
protected status -> boolean true
protected uuid -> string (36) "c0dd6217-04d9-43be-a99a-fea8657ddc78"
private isUninstalling -> boolean false
protected langcode -> string (2) "es"
protected third_party_settings -> array (0)
protected _core -> array (0)
protected trustedData -> boolean false
protected dependencies -> array (2)
config => array (3)
0 => string (49) "commerce_product.commerce_product_type.opcionales"
1 => string (35) "field.storage.commerce_product.body"
2 => string (24) "filter.format.basic_html"
module => array (1)
0 => string (4) "text"
protected isSyncing -> boolean false
protected id -> string (32) "commerce_product.opcionales.body"
protected field_name -> string (4) "body"
protected field_type -> string (17) "text_with_summary"
protected entity_type -> string (16) "commerce_product"
protected bundle -> string (10) "opcionales"
protected label -> UTF-8 string (12) "Descripción"
protected description -> string (0) ""
protected settings -> array (3)
display_summary => boolean false
required_summary => boolean false
allowed_formats => array (1)
0 => string (10) "basic_html"
protected required -> boolean false
protected translatable -> boolean true
protected default_value -> array (0)
protected default_value_callback -> null
protected fieldStorage -> null
protected itemDefinition -> null
protected constraints -> array (0)
protected propertyConstraints -> array (0)
protected deleted -> boolean false

public __construct(array $values, $entity_type = 'field_config') Constructs a FieldConfig object.

/**
 * Constructs a FieldConfig object.
 *
 * In most cases, Field entities are created via
 * FieldConfig::create($values), where $values is the same
 * parameter as in this constructor.
 *
 * @param array $values
 *   An array of field properties, keyed by property name. The
 *   storage associated with the field can be specified either with:
 *   - field_storage: the FieldStorageConfigInterface object,
 *   or by referring to an existing field storage in the current configuration
 *   with:
 *   - field_name: The field name.
 *   - entity_type: The entity type.
 *   Additionally, a 'bundle' property is required to indicate the entity
 *   bundle to which the field is attached to. Other array elements will be
 *   used to set the corresponding properties on the class; see the class
 *   property documentation for details.
 * @param string $entity_type
 *   (optional) The entity type on which the field should be created.
 *   Defaults to "field_config".
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:110

public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:143

public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) Overrides \Drupal\Core\Entity\EntityBase::preSave().

/**
 * Overrides \Drupal\Core\Entity\EntityBase::preSave().
 *
 * @throws \Drupal\Core\Field\FieldException
 *   If the field definition is invalid.
 * @throws \Drupal\Core\Entity\EntityStorageException
 *   In case of failures at the configuration storage level.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:165

public calculateDependencies() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:201

protected linkTemplates() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:264

protected urlRouteParameters($rel) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:280

public isDeleted() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:291

public getFieldStorageDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:298

public isDisplayConfigurable($context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:332

public getDisplayOptions($display_context) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:339

public isReadOnly() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:347

public isComputed() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:354

public getUniqueIdentifier() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:361

public id() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:200

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:207

public getType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:214

public getTargetEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:221

public getTargetBundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:228

public onDependencyRemoval(array $dependencies) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:262

public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:310

public getLabel() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:324

public setLabel($label) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:332

public getDescription() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:340

public setDescription($description) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:348

public isTranslatable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:356

public setTranslatable($translatable) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:365

public getSettings() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:373

public setSettings(array $settings) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:381

public getSetting($setting_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:389

public setSetting($setting_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:401

public isRequired() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:409

public setRequired($required) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:417

public getDefaultValue(Drupal\Core\Entity\FieldableEntityInterface $entity) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:425

public getDefaultValueLiteral() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:442

public setDefaultValue($value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:450

public getDefaultValueCallback() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:458

public setDefaultValueCallback($callback) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:465

public __sleep(): array Implements the magic __sleep() method.

/**
 * Implements the magic __sleep() method.
 *
 * Using the Serialize interface and serialize() / unserialize() methods
 * breaks entity forms in PHP 5.4.
 *
 * @todo Investigate in https://www.drupal.org/node/1977206.
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:478

public getDataType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:509

public isList() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:522

public getClass() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:529

public getConstraints() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:539

public getConstraint($constraint_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:546

public getItemDefinition() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:554

public getConfig($bundle) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:578

public setConstraints(array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:585

public addConstraint($constraint_name, $options = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:593

public setPropertyConstraints($name, array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:601

public addPropertyConstraints($name, array $constraints) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:614

public isInternal() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Field\FieldConfigBase
Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:629

public getOriginalId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:127

public setOriginalId($id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:134

public isNew() Overrides EntityBase::isNew().

/**
 * Overrides EntityBase::isNew().
 *
 * EntityInterface::enforceIsNew() is only supported for newly created
 * configuration entities but has no effect after saving, since each
 * configuration entity is unique.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:151

public get($property_name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:158

public set($property_name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:166

public enable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:184

public disable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:192

public setStatus($status) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:200

public status() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:208

public setUninstalling($uninstalling) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:215

public isUninstalling() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:222

public createDuplicate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:229

public toArray() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:254

protected getTypedConfig(): \Drupal\Core\Config\TypedConfigManagerInterface Gets the typed config manager.

/**
 * Gets the typed config manager.
 *
 * @return \Drupal\Core\Config\TypedConfigManagerInterface
 *   The typed configuration plugin manager.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:290

public toUrl($rel = null, array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:408

public getCacheTagsToInvalidate() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:417

protected addDependency($type, $name) Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().

/**
 * Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
 *
 * Note that this function should only be called from implementations of
 * \Drupal\Core\Config\Entity\ConfigEntityInterface::calculateDependencies(),
 * as dependencies are recalculated during every entity save.
 *
 * @see \Drupal\Core\Config\Entity\ConfigEntityDependency::hasDependency()
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:432

public getDependencies() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:446

public getConfigDependencyName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:460

public getConfigTarget() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:467

protected invalidateTagsOnSave($update) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Override to never invalidate the entity's cache tag; the config system
 * already invalidates it.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:509

public setThirdPartySetting($module, $key, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:531

public getThirdPartySetting($module, $key, $default = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:539

public getThirdPartySettings($module) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:551

public unsetThirdPartySetting($module, $key) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:558

public getThirdPartyProviders() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:571

public isInstallable() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:612

public trustData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:619

public hasTrustedData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:627

public save() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:634

protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.

/**
 * Gets the entity type manager.
 *
 * @return \Drupal\Core\Entity\EntityTypeManagerInterface
 *   The entity type manager.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85

protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.

/**
 * Gets the entity type bundle info service.
 *
 * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
 *   The entity type bundle info service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95

protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.

/**
 * Gets the language manager.
 *
 * @return \Drupal\Core\Language\LanguageManagerInterface
 *   The language manager service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105

protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.

/**
 * Gets the UUID generator.
 *
 * @return \Drupal\Component\Uuid\UuidInterface
 *   The UUID service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115

public uuid() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:129

public enforceIsNew($value = true) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143

public getEntityTypeId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152

public bundle() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:159

public label() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:166

public hasLinkTemplate($rel) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253

public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271

public uriRelationships() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315

public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:337

public language() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:351

public delete() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376

public getEntityType() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408

public referencedEntities() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:466

public getCacheContexts() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:473

protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.

/**
 * The list cache tags to invalidate for this entity.
 *
 * @return string[]
 *   Set of list cache tags.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483

public getCacheTags() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507

public getCacheMaxAge() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517

public getTypedData() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628

public getConfigDependencyKey() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673

public getOriginal(): ?static {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696

public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703

public __get($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:711

public __set($name, $value) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:722

public __isset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:734

public __unset($name) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:745

public addCacheableDependency($other_object) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15

public addCacheContexts(array $cache_contexts) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32

public addCacheTags(array $cache_tags) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42

public mergeCacheMaxAge($max_age) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52

protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.

/**
 * Sets cacheability; useful for value object constructors.
 *
 * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
 *   The cacheability to set.
 *
 * @return $this
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39

public traitSleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected getPluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance): array Calculates and returns dependencies of a specific plugin instance.

/**
 * Calculates and returns dependencies of a specific plugin instance.
 *
 * Dependencies are added for the module that provides the plugin, as well
 * as any dependencies declared by the instance's calculateDependencies()
 * method, if it implements
 * \Drupal\Component\Plugin\DependentPluginInterface.
 *
 * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
 *   The plugin instance.
 *
 * @return array
 *   An array of dependencies keyed by the type of dependency.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:33

protected calculatePluginDependencies(Drupal\Component\Plugin\PluginInspectionInterface $instance) Calculates and adds dependencies of a specific plugin instance.

/**
 * Calculates and adds dependencies of a specific plugin instance.
 *
 * Dependencies are added for the module that provides the plugin, as well
 * as any dependencies declared by the instance's calculateDependencies()
 * method, if it implements
 * \Drupal\Component\Plugin\DependentPluginInterface.
 *
 * @param \Drupal\Component\Plugin\PluginInspectionInterface $instance
 *   The plugin instance.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:88

protected moduleHandler(): \Drupal\Core\Extension\ModuleHandlerInterface Wraps the module handler.

/**
 * Wraps the module handler.
 *
 * @return \Drupal\Core\Extension\ModuleHandlerInterface
 *   The module handler.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:98

protected themeHandler(): \Drupal\Core\Extension\ThemeHandlerInterface Wraps the theme handler.

/**
 * Wraps the theme handler.
 *
 * @return \Drupal\Core\Extension\ThemeHandlerInterface
 *   The theme handler.
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Plugin/PluginDependencyTrait.php:108

protected addDependencyTrait($type, $name): $this Adds a dependency.

/**
 * Adds a dependency.
 *
 * @param string $type
 *   Type of dependency being added: 'module', 'theme', 'config', 'content'.
 * @param string $name
 *   If $type is 'module' or 'theme', the name of the module or theme. If
 *   $type is 'config' or 'content', the result of
 *   EntityInterface::getConfigDependencyName().
 *
 * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
 *
 * @return $this
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:31

protected addDependencies(array $dependencies) Adds multiple dependencies.

/**
 * Adds multiple dependencies.
 *
 * @param array $dependencies
 *   An array of dependencies keyed by the type of dependency. One example:
 *   @code
 *   [
 *     'module' => [
 *       'node',
 *       'field',
 *       'image',
 *     ],
 *   ];
 *   @endcode
 *
 * @see \Drupal\Core\Entity\DependencyTrait::addDependency
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/DependencyTrait.php:64

public setSyncing($syncing) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22

public isSyncing() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Config\Entity\ConfigEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31

private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.

/**
 * Returns the typed data class name for this entity.
 *
 * @return string
 *   The string representing the typed data class name.
 *
 * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644

public static Drupal\field\Entity\FieldConfig::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:211

public static Drupal\field\Entity\FieldConfig::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:237

/**
 * Loads a field config entity based on the entity type and field name.
 *
 * @param string $entity_type_id
 *   ID of the entity type.
 * @param string $bundle
 *   Bundle name.
 * @param string $field_name
 *   Name of the field.
 *
 * @return \Drupal\field\FieldConfigInterface|null
 *   The field config entity if one exists for the provided field
 *   name, otherwise NULL.
 */

Defined in <drupal>/core/modules/field/src/Entity/FieldConfig.php:379

public static Drupal\Core\Field\FieldConfigBase::createFromItemType($item_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:491

public static Drupal\Core\Field\FieldConfigBase::createFromDataType($type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:500

/**
 * Callback for uasort() to sort configuration entities by weight and label.
 */

Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:240

protected static Drupal\Core\Config\Entity\ConfigEntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 *
 * Override to never invalidate the individual entities' cache tags; the
 * config system already invalidates them.
 */

Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:519

protected static Drupal\Core\Config\Entity\ConfigEntityBase::getConfigManager(): \Drupal\Core\Config\ConfigManager Gets the configuration manager.

/**
 * Gets the configuration manager.
 *
 * @return \Drupal\Core\Config\ConfigManager
 *   The configuration manager.
 */

Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:605

public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:435

public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:460

public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:524

public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:534

public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:544

protected static Drupal\Core\Field\FieldConfigBase::normalizeValue(&$value, $main_property_name): array Ensure a field value is transformed into a format keyed by delta.

/**
 * Ensure a field value is transformed into a format keyed by delta.
 *
 * @param mixed $value
 *   The raw field value to normalize.
 * @param string|null $main_property_name
 *   The main field property name.
 *
 * @return array
 *   A field value normalized into a format keyed by delta.
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldInputValueNormalizerTrait.php:26

public static Drupal\Core\Field\FieldConfigBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $fields) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Field/FieldConfigBase.php:295

public static Drupal\Core\Config\Entity\ConfigEntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:578

public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:453

public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:447

protected static Drupal\Core\Entity\EntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.

/**
 * Invalidates an entity's cache tags upon delete.
 *
 * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
 *   The entity type definition.
 * @param \Drupal\Core\Entity\EntityInterface[] $entities
 *   An array of entities.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582

protected languages -> array (6)

es => Drupal\Core\Language\Language#2510 (5)

Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)

protected name -> string (7) "Spanish"
protected id -> string (2) "es"
protected direction -> string (3) "ltr"
protected weight -> integer 0
protected locked -> boolean false

public __construct(array $values = array()) Constructs a new class instance.

/**
 * Constructs a new class instance.
 *
 * @param array $values
 *   An array of property values, keyed by property name, used to construct
 *   the language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:77

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101

public getId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108

public getDirection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115

public getWeight() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122

public isDefault() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129

public isLocked() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136

public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.

/**
 * Sort language objects.
 *
 * @param \Drupal\Core\Language\LanguageInterface[] $languages
 *   The array of language objects keyed by langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146

protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.

/**
 * Gets the default langcode.
 *
 * @return string
 *   The current default langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173

public static Drupal\Core\Language\Language::$defaultValues :: array (5)
id => string (2) "en"
\Drupal\Core\Language\Language::$defaultValues['id']
name => string (7) "English"
\Drupal\Core\Language\Language::$defaultValues['name']
direction => string (3) "ltr"
\Drupal\Core\Language\Language::$defaultValues['direction']
weight => integer 0
\Drupal\Core\Language\Language::$defaultValues['weight']
locked => boolean false
\Drupal\Core\Language\Language::$defaultValues['locked']
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SYSTEM :: string (6) "system"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED :: string (3) "und"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_APPLICABLE :: string (3) "zxx"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT :: string (9) "x-default"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SITE_DEFAULT :: string (12) "site_default"
public const Drupal\Core\Language\LanguageInterface::VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
public const Drupal\Core\Language\LanguageInterface::STATE_CONFIGURABLE :: integer 1
public const Drupal\Core\Language\LanguageInterface::STATE_LOCKED :: integer 2
public const Drupal\Core\Language\LanguageInterface::STATE_ALL :: integer 3
public const Drupal\Core\Language\LanguageInterface::STATE_SITE_DEFAULT :: integer 4
public const Drupal\Core\Language\LanguageInterface::TYPE_CONTENT :: string (16) "language_content"
public const Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE :: string (18) "language_interface"
public const Drupal\Core\Language\LanguageInterface::TYPE_URL :: string (12) "language_url"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_LTR :: string (3) "ltr"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_RTL :: string (3) "rtl"

ca => Drupal\Core\Language\Language#2508 (5)

Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)

protected name -> string (7) "Catalan"
protected id -> string (2) "ca"
protected direction -> string (3) "ltr"
protected weight -> integer 1
protected locked -> boolean false

public __construct(array $values = array()) Constructs a new class instance.

/**
 * Constructs a new class instance.
 *
 * @param array $values
 *   An array of property values, keyed by property name, used to construct
 *   the language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:77

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101

public getId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108

public getDirection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115

public getWeight() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122

public isDefault() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129

public isLocked() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136

public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.

/**
 * Sort language objects.
 *
 * @param \Drupal\Core\Language\LanguageInterface[] $languages
 *   The array of language objects keyed by langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146

protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.

/**
 * Gets the default langcode.
 *
 * @return string
 *   The current default langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173

public static Drupal\Core\Language\Language::$defaultValues :: array (5)
id => string (2) "en"
\Drupal\Core\Language\Language::$defaultValues['id']
name => string (7) "English"
\Drupal\Core\Language\Language::$defaultValues['name']
direction => string (3) "ltr"
\Drupal\Core\Language\Language::$defaultValues['direction']
weight => integer 0
\Drupal\Core\Language\Language::$defaultValues['weight']
locked => boolean false
\Drupal\Core\Language\Language::$defaultValues['locked']
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SYSTEM :: string (6) "system"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED :: string (3) "und"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_APPLICABLE :: string (3) "zxx"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT :: string (9) "x-default"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SITE_DEFAULT :: string (12) "site_default"
public const Drupal\Core\Language\LanguageInterface::VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
public const Drupal\Core\Language\LanguageInterface::STATE_CONFIGURABLE :: integer 1
public const Drupal\Core\Language\LanguageInterface::STATE_LOCKED :: integer 2
public const Drupal\Core\Language\LanguageInterface::STATE_ALL :: integer 3
public const Drupal\Core\Language\LanguageInterface::STATE_SITE_DEFAULT :: integer 4
public const Drupal\Core\Language\LanguageInterface::TYPE_CONTENT :: string (16) "language_content"
public const Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE :: string (18) "language_interface"
public const Drupal\Core\Language\LanguageInterface::TYPE_URL :: string (12) "language_url"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_LTR :: string (3) "ltr"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_RTL :: string (3) "rtl"

fr => Drupal\Core\Language\Language#2511 (5)

Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)

protected name -> string (6) "French"
protected id -> string (2) "fr"
protected direction -> string (3) "ltr"
protected weight -> integer 2
protected locked -> boolean false

public __construct(array $values = array()) Constructs a new class instance.

/**
 * Constructs a new class instance.
 *
 * @param array $values
 *   An array of property values, keyed by property name, used to construct
 *   the language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:77

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101

public getId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108

public getDirection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115

public getWeight() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122

public isDefault() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129

public isLocked() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136

public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.

/**
 * Sort language objects.
 *
 * @param \Drupal\Core\Language\LanguageInterface[] $languages
 *   The array of language objects keyed by langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146

protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.

/**
 * Gets the default langcode.
 *
 * @return string
 *   The current default langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173

public static Drupal\Core\Language\Language::$defaultValues :: array (5)
id => string (2) "en"
\Drupal\Core\Language\Language::$defaultValues['id']
name => string (7) "English"
\Drupal\Core\Language\Language::$defaultValues['name']
direction => string (3) "ltr"
\Drupal\Core\Language\Language::$defaultValues['direction']
weight => integer 0
\Drupal\Core\Language\Language::$defaultValues['weight']
locked => boolean false
\Drupal\Core\Language\Language::$defaultValues['locked']
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SYSTEM :: string (6) "system"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED :: string (3) "und"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_APPLICABLE :: string (3) "zxx"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT :: string (9) "x-default"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SITE_DEFAULT :: string (12) "site_default"
public const Drupal\Core\Language\LanguageInterface::VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
public const Drupal\Core\Language\LanguageInterface::STATE_CONFIGURABLE :: integer 1
public const Drupal\Core\Language\LanguageInterface::STATE_LOCKED :: integer 2
public const Drupal\Core\Language\LanguageInterface::STATE_ALL :: integer 3
public const Drupal\Core\Language\LanguageInterface::STATE_SITE_DEFAULT :: integer 4
public const Drupal\Core\Language\LanguageInterface::TYPE_CONTENT :: string (16) "language_content"
public const Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE :: string (18) "language_interface"
public const Drupal\Core\Language\LanguageInterface::TYPE_URL :: string (12) "language_url"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_LTR :: string (3) "ltr"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_RTL :: string (3) "rtl"

en => Drupal\Core\Language\Language#2509 (5)

Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)

protected name -> string (7) "English"
protected id -> string (2) "en"
protected direction -> string (3) "ltr"
protected weight -> integer 3
protected locked -> boolean false

public __construct(array $values = array()) Constructs a new class instance.

/**
 * Constructs a new class instance.
 *
 * @param array $values
 *   An array of property values, keyed by property name, used to construct
 *   the language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:77

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101

public getId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108

public getDirection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115

public getWeight() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122

public isDefault() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129

public isLocked() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136

public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.

/**
 * Sort language objects.
 *
 * @param \Drupal\Core\Language\LanguageInterface[] $languages
 *   The array of language objects keyed by langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146

protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.

/**
 * Gets the default langcode.
 *
 * @return string
 *   The current default langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173

public static Drupal\Core\Language\Language::$defaultValues :: array (5)
id => string (2) "en"
\Drupal\Core\Language\Language::$defaultValues['id']
name => string (7) "English"
\Drupal\Core\Language\Language::$defaultValues['name']
direction => string (3) "ltr"
\Drupal\Core\Language\Language::$defaultValues['direction']
weight => integer 0
\Drupal\Core\Language\Language::$defaultValues['weight']
locked => boolean false
\Drupal\Core\Language\Language::$defaultValues['locked']
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SYSTEM :: string (6) "system"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED :: string (3) "und"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_APPLICABLE :: string (3) "zxx"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT :: string (9) "x-default"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SITE_DEFAULT :: string (12) "site_default"
public const Drupal\Core\Language\LanguageInterface::VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
public const Drupal\Core\Language\LanguageInterface::STATE_CONFIGURABLE :: integer 1
public const Drupal\Core\Language\LanguageInterface::STATE_LOCKED :: integer 2
public const Drupal\Core\Language\LanguageInterface::STATE_ALL :: integer 3
public const Drupal\Core\Language\LanguageInterface::STATE_SITE_DEFAULT :: integer 4
public const Drupal\Core\Language\LanguageInterface::TYPE_CONTENT :: string (16) "language_content"
public const Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE :: string (18) "language_interface"
public const Drupal\Core\Language\LanguageInterface::TYPE_URL :: string (12) "language_url"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_LTR :: string (3) "ltr"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_RTL :: string (3) "rtl"

und => Drupal\Core\Language\Language#2512 (5)

Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)

protected name -> string (15) "Sin especificar"
protected id -> string (3) "und"
protected direction -> string (3) "ltr"
protected weight -> integer 4
protected locked -> boolean true

public __construct(array $values = array()) Constructs a new class instance.

/**
 * Constructs a new class instance.
 *
 * @param array $values
 *   An array of property values, keyed by property name, used to construct
 *   the language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:77

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101

public getId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108

public getDirection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115

public getWeight() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122

public isDefault() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129

public isLocked() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136

public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.

/**
 * Sort language objects.
 *
 * @param \Drupal\Core\Language\LanguageInterface[] $languages
 *   The array of language objects keyed by langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146

protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.

/**
 * Gets the default langcode.
 *
 * @return string
 *   The current default langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173

public static Drupal\Core\Language\Language::$defaultValues :: array (5)
id => string (2) "en"
\Drupal\Core\Language\Language::$defaultValues['id']
name => string (7) "English"
\Drupal\Core\Language\Language::$defaultValues['name']
direction => string (3) "ltr"
\Drupal\Core\Language\Language::$defaultValues['direction']
weight => integer 0
\Drupal\Core\Language\Language::$defaultValues['weight']
locked => boolean false
\Drupal\Core\Language\Language::$defaultValues['locked']
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SYSTEM :: string (6) "system"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED :: string (3) "und"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_APPLICABLE :: string (3) "zxx"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT :: string (9) "x-default"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SITE_DEFAULT :: string (12) "site_default"
public const Drupal\Core\Language\LanguageInterface::VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
public const Drupal\Core\Language\LanguageInterface::STATE_CONFIGURABLE :: integer 1
public const Drupal\Core\Language\LanguageInterface::STATE_LOCKED :: integer 2
public const Drupal\Core\Language\LanguageInterface::STATE_ALL :: integer 3
public const Drupal\Core\Language\LanguageInterface::STATE_SITE_DEFAULT :: integer 4
public const Drupal\Core\Language\LanguageInterface::TYPE_CONTENT :: string (16) "language_content"
public const Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE :: string (18) "language_interface"
public const Drupal\Core\Language\LanguageInterface::TYPE_URL :: string (12) "language_url"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_LTR :: string (3) "ltr"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_RTL :: string (3) "rtl"

zxx => Drupal\Core\Language\Language#2503 (5)

Properties (5)
Methods (7)
Static methods (2)
Static properties (1)
Class constants (15)

protected name -> string (12) "No aplicable"
protected id -> string (3) "zxx"
protected direction -> string (3) "ltr"
protected weight -> integer 5
protected locked -> boolean true

public __construct(array $values = array()) Constructs a new class instance.

/**
 * Constructs a new class instance.
 *
 * @param array $values
 *   An array of property values, keyed by property name, used to construct
 *   the language.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:77

public getName() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:101

public getId() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:108

public getDirection() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:115

public getWeight() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:122

public isDefault() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:129

public isLocked() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:136

public static Drupal\Core\Language\Language::sort(&$languages) Sort language objects.

/**
 * Sort language objects.
 *
 * @param \Drupal\Core\Language\LanguageInterface[] $languages
 *   The array of language objects keyed by langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:146

protected static Drupal\Core\Language\Language::getDefaultLangcode(): string Gets the default langcode.

/**
 * Gets the default langcode.
 *
 * @return string
 *   The current default langcode.
 */

Defined in <drupal>/core/lib/Drupal/Core/Language/Language.php:173

public static Drupal\Core\Language\Language::$defaultValues :: array (5)
id => string (2) "en"
\Drupal\Core\Language\Language::$defaultValues['id']
name => string (7) "English"
\Drupal\Core\Language\Language::$defaultValues['name']
direction => string (3) "ltr"
\Drupal\Core\Language\Language::$defaultValues['direction']
weight => integer 0
\Drupal\Core\Language\Language::$defaultValues['weight']
locked => boolean false
\Drupal\Core\Language\Language::$defaultValues['locked']
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SYSTEM :: string (6) "system"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED :: string (3) "und"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_APPLICABLE :: string (3) "zxx"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT :: string (9) "x-default"
public const Drupal\Core\Language\LanguageInterface::LANGCODE_SITE_DEFAULT :: string (12) "site_default"
public const Drupal\Core\Language\LanguageInterface::VALID_LANGCODE_REGEX :: string (33) "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*"
public const Drupal\Core\Language\LanguageInterface::STATE_CONFIGURABLE :: integer 1
public const Drupal\Core\Language\LanguageInterface::STATE_LOCKED :: integer 2
public const Drupal\Core\Language\LanguageInterface::STATE_ALL :: integer 3
public const Drupal\Core\Language\LanguageInterface::STATE_SITE_DEFAULT :: integer 4
public const Drupal\Core\Language\LanguageInterface::TYPE_CONTENT :: string (16) "language_content"
public const Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE :: string (18) "language_interface"
public const Drupal\Core\Language\LanguageInterface::TYPE_URL :: string (12) "language_url"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_LTR :: string (3) "ltr"
public const Drupal\Core\Language\LanguageInterface::DIRECTION_RTL :: string (3) "rtl"

protected langcodeKey -> string (8) "langcode"

protected defaultLangcodeKey -> string (16) "default_langcode"

protected activeLangcode -> string (9) "x-default"

protected enforceDefaultTranslation -> null

protected defaultLangcode -> string (2) "es"

protected translations -> array (1)

x-default => array (1)

status => integer 1

protected translationInitialize -> boolean false

protected newRevision -> boolean false

protected isDefaultRevision -> boolean true

protected entityKeys -> array (3)

bundle => string (10) "opcionales"

id => string (1) "6"

uuid => string (36) "6eb611e5-0c3d-4952-8821-1f90f46f5ffa"

protected translatableEntityKeys -> array (6)

label => array (1)

x-default => string (11) "Extra carga"

langcode => array (1)

x-default => string (2) "es"

published => array (1)

x-default => string (1) "1"

owner => array (1)

x-default => string (1) "2"

uid => array (1)

x-default => string (1) "2"

default_langcode => array (1)

x-default => string (1) "1"

protected validated -> boolean false

protected validationRequired -> boolean false

protected loadedRevisionId -> null

protected revisionTranslationAffectedKey -> string (29) "revision_translation_affected"

protected enforceRevisionTranslationAffected -> array (0)

protected isSyncing -> boolean false

protected defaultVariation -> null

public getTitle() {@inheritdoc} $0->getTitle()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:99

public setTitle($title) {@inheritdoc} $0->setTitle()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:106

public getCreatedTime() {@inheritdoc} $0->getCreatedTime()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:114

public setCreatedTime($timestamp) {@inheritdoc} $0->setCreatedTime()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:121

public getStores() {@inheritdoc} $0->getStores()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:129

public setStores(array $stores) {@inheritdoc} $0->setStores()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:136

public getStoreIds() {@inheritdoc} $0->getStoreIds()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:144

public setStoreIds(array $store_ids) {@inheritdoc} $0->setStoreIds()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:155

public getVariationIds() {@inheritdoc} $0->getVariationIds()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:163

public getVariations() {@inheritdoc} $0->getVariations()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:174

public setVariations(array $variations) {@inheritdoc} $0->setVariations()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:181

public hasVariations() {@inheritdoc} $0->hasVariations()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:189

public addVariation(Drupal\commerce_product\Entity\ProductVariationInterface $variation) {@inheritdoc} $0->addVariation()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:196

public removeVariation(Drupal\commerce_product\Entity\ProductVariationInterface $variation) {@inheritdoc} $0->removeVariation()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:206

public hasVariation(Drupal\commerce_product\Entity\ProductVariationInterface $variation) {@inheritdoc} $0->hasVariation()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:217

protected getVariationIndex(Drupal\commerce_product\Entity\ProductVariationInterface $variation): int|bool Gets the index of the given variation.

/**
 * Gets the index of the given variation.
 *
 * @param \Drupal\commerce_product\Entity\ProductVariationInterface $variation
 *   The variation.
 *
 * @return int|bool
 *   The index of the given variation, or FALSE if not found.
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:230

public getDefaultVariation() {@inheritdoc} $0->getDefaultVariation()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:237

public preSave(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc} $0->preSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:259

public postSave(Drupal\Core\Entity\EntityStorageInterface $storage, $update = true) {@inheritdoc} $0->postSave()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:277

public getCacheContexts() {@inheritdoc} $0->getCacheContexts()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:293

public getTranslatedReferencedEntities($field_name) {@inheritdoc} $0->getTranslatedReferencedEntities()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\commerce\Entity\CommerceContentEntityBase
Defined in <drupal>/modules/contrib/commerce/src/Entity/CommerceContentEntityBase.php:17

public getTranslatedReferencedEntity($field_name) {@inheritdoc} $0->getTranslatedReferencedEntity()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\commerce\Entity\CommerceContentEntityBase
Defined in <drupal>/modules/contrib/commerce/src/Entity/CommerceContentEntityBase.php:25

protected ensureTranslations(array $entities): \Drupal\Core\Entity\ContentEntityInterface[] Ensures entities are in the current entity's language, if possible.

/**
 * Ensures entities are in the current entity's language, if possible.
 *
 * @param \Drupal\Core\Entity\ContentEntityInterface[] $entities
 *   The entities to process.
 *
 * @return \Drupal\Core\Entity\ContentEntityInterface[]
 *   The processed entities.
 */

Inherited from Drupal\commerce\Entity\CommerceContentEntityBase
Defined in <drupal>/modules/contrib/commerce/src/Entity/CommerceContentEntityBase.php:40

public __construct(array $values, $entity_type, $bundle = false, $translations = array()) {@inheritdoc} new \Drupal\commerce_product\Entity\Product()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:203

protected getLanguages() {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:282

public postCreate(Drupal\Core\Entity\EntityStorageInterface $storage) {@inheritdoc} $0->postCreate()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:298

public setNewRevision($value = true) {@inheritdoc} $0->setNewRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:305

public getLoadedRevisionId() {@inheritdoc} $0->getLoadedRevisionId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:327

public updateLoadedRevisionId() {@inheritdoc} $0->updateLoadedRevisionId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:334

public isNewRevision() {@inheritdoc} $0->isNewRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:342

public isDefaultRevision($new_value = null) {@inheritdoc} $0->isDefaultRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:349

public wasDefaultRevision() {@inheritdoc} $0->wasDefaultRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:362

public isLatestRevision() {@inheritdoc} $0->isLatestRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:377

public isLatestTranslationAffectedRevision() {@inheritdoc} $0->isLatestTranslationAffectedRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:387

public isRevisionTranslationAffected() {@inheritdoc} $0->isRevisionTranslationAffected()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:397

public setRevisionTranslationAffected($affected) {@inheritdoc} $0->setRevisionTranslationAffected()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:404

public isRevisionTranslationAffectedEnforced() {@inheritdoc} $0->isRevisionTranslationAffectedEnforced()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:414

public setRevisionTranslationAffectedEnforced($enforced) {@inheritdoc} $0->setRevisionTranslationAffectedEnforced()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:421

public setDefaultTranslationEnforced(?bool $enforce_default_translation): static Set or clear an override of the isDefaultTranslation() result. $0->setDefaultTranslationEnforced()

/**
 * Set or clear an override of the isDefaultTranslation() result.
 *
 * @param bool|null $enforce_default_translation
 *   If boolean value is passed, the value will override the result of
 *   isDefaultTranslation() method. If NULL is passed, the default logic will
 *   be used.
 *
 * @return $this
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:436

public isDefaultTranslation() {@inheritdoc} $0->isDefaultTranslation()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:444

public getRevisionId() {@inheritdoc} $0->getRevisionId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:454

public isTranslatable() {@inheritdoc} $0->isTranslatable()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:461

public preSaveRevision(Drupal\Core\Entity\EntityStorageInterface $storage, stdClass $record) {@inheritdoc} $0->preSaveRevision()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:487

public validate() {@inheritdoc} $0->validate()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:518

public isValidationRequired() {@inheritdoc} $0->isValidationRequired()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:527

public setValidationRequired($required) {@inheritdoc} $0->setValidationRequired()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:534

protected clearTranslationCache() Clears entity translation object cache to remove stale references.

/**
 * Clears entity translation object cache to remove stale references.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:542

public __sleep(): array {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:551

public id() {@inheritdoc} $0->id()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:569

public bundle() {@inheritdoc} $0->bundle()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:576

public getBundleEntity(): ?Drupal\Core\Entity\EntityInterface {@inheritdoc} $0->getBundleEntity()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:583

public uuid() {@inheritdoc} $0->uuid()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:594

public hasField($field_name) {@inheritdoc} $0->hasField()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:601

public get($field_name) {@inheritdoc} $0->get()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:608

protected getTranslatedField($name, $langcode): \Drupal\Core\Field\FieldItemListInterface<\Drupal\Core\Field\FieldItemInterface> Gets a translated field.

/**
 * Gets a translated field.
 *
 * @return \Drupal\Core\Field\FieldItemListInterface<\Drupal\Core\Field\FieldItemInterface>
 *   The translated field.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:621

public set($name, $value, $notify = true) {@inheritdoc} $0->set()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:667

public getFields($include_computed = true) {@inheritdoc} $0->getFields()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:678

public getTranslatableFields($include_computed = true) {@inheritdoc} $0->getTranslatableFields()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:691

public getIterator(): ArrayIterator Retrieves the iterator for the object. $0->getIterator()

/**
 * Retrieves the iterator for the object.
 *
 * @return \ArrayIterator<string, \Drupal\Core\Field\FieldItemListInterface<\Drupal\Core\Field\FieldItemInterface>>
 *   The iterator.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:707

public getFieldDefinition($name) {@inheritdoc} $0->getFieldDefinition()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:714

public getFieldDefinitions() {@inheritdoc} $0->getFieldDefinitions()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:726

public toArray() {@inheritdoc} $0->toArray()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:736

public access($operation, ?Drupal\Core\Session\AccountInterface $account = null, $return_as_object = false) {@inheritdoc} $0->access()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:747

public language() {@inheritdoc} $0->language()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:761

protected setDefaultLangcode() Populates the local cache for the default language code.

/**
 * Populates the local cache for the default language code.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:783

protected updateFieldLangcodes($langcode) Updates language for already instantiated fields.

/**
 * Updates language for already instantiated fields.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:816

public onChange($name) {@inheritdoc} $0->onChange()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:827

public getTranslation($langcode) {@inheritdoc} $0->getTranslation()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:893

public getUntranslated() {@inheritdoc} $0->getUntranslated()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:928

protected initializeTranslation($langcode): \Drupal\Core\Entity\EntityInterface Instantiates a translation object for an existing translation.

/**
 * Instantiates a translation object for an existing translation.
 *
 * The translated entity will be a clone of the current entity with the
 * specified $langcode. All translations share the same field data structures
 * to ensure that all of them deal with fresh data.
 *
 * @param string $langcode
 *   The language code for the requested translation.
 *
 * @return \Drupal\Core\Entity\EntityInterface
 *   The translation object. The content properties of the translation object
 *   are stored as references to the main entity.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:946

public hasTranslation($langcode) {@inheritdoc} $0->hasTranslation()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:980

public isNewTranslation() {@inheritdoc} $0->isNewTranslation()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:990

public addTranslation($langcode, array $values = array()) {@inheritdoc} $0->addTranslation()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:997

public removeTranslation($langcode) {@inheritdoc} $0->removeTranslation()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1018

public getTranslationStatus($langcode) {@inheritdoc} $0->getTranslationStatus()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1047

public getTranslationLanguages($include_default = true) {@inheritdoc} $0->getTranslationLanguages()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1057

public updateOriginalValues() Updates the original values with the interim changes. $0->updateOriginalValues()

/**
 * Updates the original values with the interim changes.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1074

public & __get($name) Implements the magic method for getting object properties.

/**
 * Implements the magic method for getting object properties.
 *
 * @todo A lot of code still uses non-fields (e.g. $entity->content in view
 *   builders) by reference. Clean that up.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1094

public __set($name, $value) Implements the magic method for setting object properties.

/**
 * Implements the magic method for setting object properties.
 *
 * Uses default language always.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1126

public __isset($name) Implements the magic method for isset().

/**
 * Implements the magic method for isset().
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1163

public __unset($name) Implements the magic method for unset().

/**
 * Implements the magic method for unset().
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1175

public createDuplicate() {@inheritdoc} $0->createDuplicate()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1209

public __clone() Magic method: Implements a deep clone. clone $0

/**
 * Magic method: Implements a deep clone.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1247

public label() {@inheritdoc} $0->label()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1333

public referencedEntities() {@inheritdoc} $0->referencedEntities()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1342

protected getEntityKey($key): mixed Gets the value of the given entity key, if defined.

/**
 * Gets the value of the given entity key, if defined.
 *
 * @param string $key
 *   Name of the entity key, for example id, revision or bundle.
 *
 * @return mixed
 *   The value of the entity key, NULL if not defined.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1369

protected getFieldsToSkipFromTranslationChangesCheck(): array Returns an array of field names to skip in ::hasTranslationChanges.

/**
 * Returns an array of field names to skip in ::hasTranslationChanges.
 *
 * @return array
 *   An array of field names.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1471

public hasTranslationChanges() {@inheritdoc} $0->hasTranslationChanges()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1482

public isDefaultTranslationAffectedOnly() {@inheritdoc} $0->isDefaultTranslationAffectedOnly()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1544

protected entityTypeManager(): \Drupal\Core\Entity\EntityTypeManagerInterface Gets the entity type manager.

/**
 * Gets the entity type manager.
 *
 * @return \Drupal\Core\Entity\EntityTypeManagerInterface
 *   The entity type manager.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:85

protected entityTypeBundleInfo(): \Drupal\Core\Entity\EntityTypeBundleInfoInterface Gets the entity type bundle info service.

/**
 * Gets the entity type bundle info service.
 *
 * @return \Drupal\Core\Entity\EntityTypeBundleInfoInterface
 *   The entity type bundle info service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:95

protected languageManager(): \Drupal\Core\Language\LanguageManagerInterface Gets the language manager.

/**
 * Gets the language manager.
 *
 * @return \Drupal\Core\Language\LanguageManagerInterface
 *   The language manager service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:105

protected uuidGenerator(): \Drupal\Component\Uuid\UuidInterface Gets the UUID generator.

/**
 * Gets the UUID generator.
 *
 * @return \Drupal\Component\Uuid\UuidInterface
 *   The UUID service.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:115

public isNew() {@inheritdoc} $0->isNew()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:136

public enforceIsNew($value = true) {@inheritdoc} $0->enforceIsNew()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:143

public getEntityTypeId() {@inheritdoc} $0->getEntityTypeId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:152

public toUrl($rel = null, array $options = array()) {@inheritdoc} $0->toUrl()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:175

public hasLinkTemplate($rel) {@inheritdoc} $0->hasLinkTemplate()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:253

protected linkTemplates(): array Gets an array link templates.

/**
 * Gets an array link templates.
 *
 * @return array
 *   An array of link templates containing paths.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:264

public toLink($text = null, $rel = 'canonical', array $options = array()) {@inheritdoc} $0->toLink()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:271

protected urlRouteParameters($rel): array Gets an array of placeholders for this entity.

/**
 * Gets an array of placeholders for this entity.
 *
 * Individual entity classes may override this method to add additional
 * placeholders if desired. If so, they should be sure to replicate the
 * property caching logic.
 *
 * @param string $rel
 *   The link relationship type, for example: canonical or edit-form.
 *
 * @return array
 *   An array of URI placeholders.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:294

public uriRelationships() {@inheritdoc} $0->uriRelationships()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:315

public save() {@inheritdoc} $0->save()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:368

public delete() {@inheritdoc} $0->delete()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:376

public getEntityType() {@inheritdoc} $0->getEntityType()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:408

protected getListCacheTagsToInvalidate(): string[] The list cache tags to invalidate for this entity.

/**
 * The list cache tags to invalidate for this entity.
 *
 * @return string[]
 *   Set of list cache tags.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:483

public getCacheTagsToInvalidate() {@inheritdoc} $0->getCacheTagsToInvalidate()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:497

public getCacheTags() {@inheritdoc} $0->getCacheTags()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:507

public getCacheMaxAge() {@inheritdoc} $0->getCacheMaxAge()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:517

protected invalidateTagsOnSave($update) Invalidates an entity's cache tags upon save.

/**
 * Invalidates an entity's cache tags upon save.
 *
 * @param bool $update
 *   TRUE if the entity has been updated, or FALSE if it has been inserted.
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:557

public getOriginalId() {@inheritdoc} $0->getOriginalId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:599

public setOriginalId($id) {@inheritdoc} $0->setOriginalId()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:607

public getTypedData() {@inheritdoc} $0->getTypedData()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:628

public getConfigDependencyKey() {@inheritdoc} $0->getConfigDependencyKey()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:673

public getConfigDependencyName() {@inheritdoc} $0->getConfigDependencyName()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:680

public getConfigTarget() {@inheritdoc} $0->getConfigTarget()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:687

public getOriginal(): ?static {@inheritdoc} $0->getOriginal()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:696

public setOriginal(?Drupal\Core\Entity\EntityInterface $original): static {@inheritdoc} $0->setOriginal()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:703

public addCacheableDependency($other_object) {@inheritdoc} $0->addCacheableDependency()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:15

public addCacheContexts(array $cache_contexts) {@inheritdoc} $0->addCacheContexts()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:32

public addCacheTags(array $cache_tags) {@inheritdoc} $0->addCacheTags()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:42

public mergeCacheMaxAge($max_age) {@inheritdoc} $0->mergeCacheMaxAge()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/RefinableCacheableDependencyTrait.php:52

protected setCacheability(Drupal\Core\Cache\CacheableDependencyInterface $cacheability): $this Sets cacheability; useful for value object constructors.

/**
 * Sets cacheability; useful for value object constructors.
 *
 * @param \Drupal\Core\Cache\CacheableDependencyInterface $cacheability
 *   The cacheability to set.
 *
 * @return $this
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Cache/CacheableDependencyTrait.php:39

public traitSleep(): array {@inheritdoc} $0->traitSleep()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:33

public __wakeup(): void {@inheritdoc}

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/DependencyInjection/DependencySerializationTrait.php:73

protected traitGetFieldsToSkipFromTranslationChangesCheck(Drupal\Core\Entity\ContentEntityInterface $entity): string[] Returns an array of field names to skip when checking for changes.

/**
 * Returns an array of field names to skip when checking for changes.
 *
 * @param \Drupal\Core\Entity\ContentEntityInterface $entity
 *   A content entity object.
 *
 * @return string[]
 *   An array of field names.
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangesDetectionTrait.php:21

public setSyncing($syncing) {@inheritdoc} $0->setSyncing()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:22

public isSyncing() {@inheritdoc} $0->isSyncing()

/**
 * {@inheritdoc}
 */

Inherited from Drupal\Core\Entity\ContentEntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/SynchronizableEntityTrait.php:31

public getChangedTimeAcrossTranslations(): int Returns the timestamp of the last entity change across all translations. $0->getChangedTimeAcrossTranslations()

/**
 * Returns the timestamp of the last entity change across all translations.
 *
 * @return int
 *   The timestamp of the last entity save operation across all
 *   translations.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:17

public getChangedTime(): int|null Gets the timestamp of the last entity change for the current translation. $0->getChangedTime()

/**
 * Gets the timestamp of the last entity change for the current translation.
 *
 * @return int|null
 *   The timestamp of the last entity save operation. Some entities allow a
 *   NULL value indicating the changed time is unknown.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:33

public setChangedTime($timestamp): $this Sets the timestamp of the last entity change for the current translation. $0->setChangedTime()

/**
 * Sets the timestamp of the last entity change for the current translation.
 *
 * @param int $timestamp
 *   The timestamp of the last entity save operation.
 *
 * @return $this
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityChangedTrait.php:46

public getOwner() {@inheritdoc} $0->getOwner()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/src/EntityOwnerTrait.php:18

public getOwnerId() {@inheritdoc} $0->getOwnerId()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:48

public setOwnerId($uid) {@inheritdoc} $0->setOwnerId()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:55

public setOwner(Drupal\user\UserInterface $account) {@inheritdoc} $0->setOwner()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:73

public isPublished() {@inheritdoc} $0->isPublished()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:47

public setPublished() {@inheritdoc} $0->setPublished()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:54

public setUnpublished() {@inheritdoc} $0->setUnpublished()

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:64

private Drupal\Core\Entity\EntityBase::getTypedDataClass(): string Returns the typed data class name for this entity.

/**
 * Returns the typed data class name for this entity.
 *
 * @return string
 *   The string representing the typed data class name.
 *
 * @see \Drupal\Core\Entity\Plugin\DataType\EntityAdapter
 */

Inherited from Drupal\Core\Entity\EntityBase
Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:644

public static Drupal\commerce_product\Entity\Product::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:300

public static Drupal\commerce_product\Entity\Product::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:322

public static Drupal\commerce_product\Entity\Product::bundleFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/modules/contrib/commerce/modules/product/src/Entity/Product.php:441

public static Drupal\Core\Entity\ContentEntityBase::create(array $values = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1192

public static Drupal\Core\Entity\EntityBase::preCreate(Drupal\Core\Entity\EntityStorageInterface $storage, array &$values) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:435

public static Drupal\Core\Entity\EntityBase::preDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:447

public static Drupal\Core\Entity\EntityBase::postLoad(Drupal\Core\Entity\EntityStorageInterface $storage, array &$entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:460

public static Drupal\Core\Entity\EntityBase::load($id) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:524

public static Drupal\Core\Entity\EntityBase::loadMultiple(?array $ids = null) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:534

protected static Drupal\Core\Entity\EntityBase::invalidateTagsOnDelete(Drupal\Core\Entity\EntityTypeInterface $entity_type, array $entities) Invalidates an entity's cache tags upon delete.

/**
 * Invalidates an entity's cache tags upon delete.
 *
 * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
 *   The entity type definition.
 * @param \Drupal\Core\Entity\EntityInterface[] $entities
 *   An array of entities.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:582

public static Drupal\commerce_product\Entity\Product::ownerBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\BaseFieldDefinition[] Returns an array of base field definitions for entity owners.

/**
 * Returns an array of base field definitions for entity owners.
 *
 * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
 *   The entity type to add the owner field to.
 *
 * @return \Drupal\Core\Field\BaseFieldDefinition[]
 *   An array of base field definitions.
 *
 * @throws \Drupal\Core\Entity\Exception\UnsupportedEntityTypeDefinitionException
 *   Thrown when the entity type does not implement EntityOwnerInterface or
 *   if it does not have an "owner" entity key.
 */

Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:28

public static Drupal\commerce_product\Entity\Product::getDefaultEntityOwner(): mixed Default value callback for 'owner' base field.

/**
 * Default value callback for 'owner' base field.
 *
 * @return mixed
 *   A default value for the owner field.
 */

Defined in <drupal>/core/modules/user/src/EntityOwnerTrait.php:86

public static Drupal\commerce_product\Entity\Product::publishedBaseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type): \Drupal\Core\Field\BaseFieldDefinition[] Returns an array of base field definitions for publishing status.

/**
 * Returns an array of base field definitions for publishing status.
 *
 * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
 *   The entity type to add the publishing status field to.
 *
 * @return \Drupal\Core\Field\BaseFieldDefinition[]
 *   An array of base field definitions.
 *
 * @throws \Drupal\Core\Entity\Exception\UnsupportedEntityTypeDefinitionException
 *   Thrown when the entity type does not implement EntityPublishedInterface
 *   or if it does not have a "published" entity key.
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityPublishedTrait.php:27

public static Drupal\Core\Entity\ContentEntityBase::baseFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1403

public static Drupal\Core\Entity\ContentEntityBase::bundleFieldDefinitions(Drupal\Core\Entity\EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/ContentEntityBase.php:1461

public static Drupal\Core\Entity\EntityBase::postDelete(Drupal\Core\Entity\EntityStorageInterface $storage, array $entities) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:453

public static Drupal\Core\Entity\EntityBase::create(array $values = array()) {@inheritdoc}

/**
 * {@inheritdoc}
 */

Defined in <drupal>/core/lib/Drupal/Core/Entity/EntityBase.php:544

protected static Drupal\Core\Entity\ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck :: array (0)
public const Drupal\Core\TypedData\TranslationStatusInterface::TRANSLATION_REMOVED :: integer 0
public const Drupal\Core\TypedData\TranslationStatusInterface::TRANSLATION_EXISTING :: integer 1
public const Drupal\Core\TypedData\TranslationStatusInterface::TRANSLATION_CREATED :: integer 2
⇄
Drupal\Core\Entity\FieldableEntityInterface Iterator Contents uninitialized Blacklisted
iterator_to_array($0, false)